当前位置:首页 > 服务端 > Swagger

Swagger

2022年09月17日 13:17:13服务端7
  1. 添加引用 Swashbuckle.AspNetCore
  2. 配置服务
    Swagger _ JavaClub全栈架构师技术笔记
    public void ConfigureServices(IServiceCollection services)
            {
                services.AddMvc();
    
                #region Swagger
                services.AddSwaggerGen(c =>
                {
                    c.SwaggerDoc("v1", new Info
                    {
                        Version = "v0.1.0",
                        Title = "Blog.Core API",
                        Description = "框架说明文档",
                        TermsOfService = "None",
                        Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "Blog.Core", Email = "Blog.Core@xxx.com", Url = "https://www.jianshu.com/u/94102b59cc2a" }
                    });
                });
    
                #endregion
    
            }
    配置服务
  3. 添加中间件
    Swagger _ JavaClub全栈架构师技术笔记
    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
            public void Configure(IApplicationBuilder app, IHostingEnvironment env)
            {
                if (env.IsDevelopment())
                {
                    app.UseDeveloperExceptionPage();
                }
    
                #region Swagger
                app.UseSwagger();
                app.UseSwaggerUI(c =>
                {
                    c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
                });
                #endregion
    
                app.UseMvc();
            }
    添加中间件
  4. F5运行调试。在域名后面输入 /swagger   (如果要自动打开 swagger, 在lanchSettings.json 中配置 launchUrl )
    Swagger _ JavaClub全栈架构师技术笔记
    {
      "$schema": "http://json.schemastore.org/launchsettings.json",
      "iisSettings": {
        "windowsAuthentication": false, 
        "anonymousAuthentication": true, 
        "iisExpress": {
          "applicationUrl": "http://localhost:55159",
          "sslPort": 0
        }
      },
      "profiles": {
        "IIS Express": {
          "commandName": "IISExpress",
          "launchBrowser": true,
          "launchUrl": "swagger",
          "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Development"
          }
        },
        "ProjectManager.Api": {
          "commandName": "Project",
          "launchBrowser": true,
          "launchUrl": "swagger",
          "applicationUrl": "http://localhost:5000",
          "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Development"
          }
        }
      }
    }
    lanchSettings.json

作者:Ken-Cai
来源链接:https://www.cnblogs.com/Ken-Cai/p/10339806.html

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/server/42709.html

标签: Swagger
分享给朋友:

“Swagger” 的相关文章

SpringBoot整合Swagger和Actuator

SpringBoot整合Swagger和Actuator

前言 本篇文章主要介绍的是SpringBoot整合Swagger(API文档生成框架)和SpringBoot整合Actuator(项目监控)使用教程。 SpringBoot整合Swagger 说明:如果想直接获取工程那么可以直接跳到底部,通过链接下载工程代码。...

Maven + SpringMVC项目集成Swagger

Maven + SpringMVC项目集成Swagger

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。 作用:  接...

SpringBoot整合Swagger3生成接口文档

SpringBoot整合Swagger3生成接口文档

  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的开发环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。 一、pom文件中引入Swagger3依赖...

.net core在Ocelot网关中统一配置Swagger

.net core在Ocelot网关中统一配置Swagger

最近在做微服务的时候,由于我们是采用前后端分离来开发的,提供给前端的直接是Swagger,如果Swagger分布在各个API中,前端查看Swagger的时候非常不便,因此,我们试着将Swagger集中放到网关中。 这里我用两个API项目(一个BasicDataApi,一个User...

Swagger使用

Swagger使用

原文:https://www.cnblogs.com/liruiloveparents/p/9378327.html     Swagger学习及生成HTML文档 Swagger 1、集成springboot 第一步:pom...

配置 Swagger 带 token 访问的两种方式

配置 Swagger 带 token 访问的两种方式

推荐使用全局的方式 1. 每个接口单独传 import com.google.common.collect.Lists; import org.springframework.beans.factory.annotation.Value; impo...

ABP使用NSwagStudio for Swagger Api生成ServiceProxies

ABP使用NSwagStudio for Swagger Api生成ServiceProxies

案例主要是使用NSwag来生成ABP for angular 2+的客户端代码。 NSwagStudio 下载地址 比较强大、可以生成TypeScript、WebApi Controller、CSharp Client  1:运行Web.Host项目&n...

asp.net core 集成swagger ui

asp.net core 集成swagger ui

什么是Swagger? 说swagger 之前,我们先说一下OpenApi 规范。 OpenApi 是一种和语言无关的用于描述RESTAPIs 接口功能的一种规范,对RESTAPIs 接口的描述包括: 接口参数信息、接口返回值信息、api 功能描述、请求路径等。 这里...

Swagger结合mustache模板生成后台接口代码、以及前后台建模代码

Swagger结合mustache模板生成后台接口代码、以及前后台建模代码

之前项目中使用的的thrift来建模,维护前后台模型以及rest接口,前台使用的是angular2;  但是使用thrift只能生成建模,后台的rest接口的Controller文件还是需要手动去写,一旦接口改动就会涉及到很多方面。 由此准备使用Swagger和m...

springmvc+swagger构建Restful风格文档

springmvc+swagger构建Restful风格文档

  本次和大家分享的是java方面的springmvc来构建的webapi接口+swagger文档;上篇文章分享.net的webapi用swagger来构建文档,因为有朋友问了为啥.net有docpage文档你还用swagger,这里主要目的是让接口文档统一,当操作多种开发语言做接口时...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。