Swagger

Posted ken-cai

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Swagger相关的知识,希望对你有一定的参考价值。

  1. 添加引用 Swashbuckle.AspNetCore
  2. 配置服务
    技术分享图片
    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 = "[email protected]", Url = "https://www.jianshu.com/u/94102b59cc2a" }
                    });
                });
    
                #endregion
    
            }
    配置服务
  3. 添加中间件
    技术分享图片
    // 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 )
    技术分享图片
    {
      "$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

以上是关于Swagger的主要内容,如果未能解决你的问题,请参考以下文章

用swagger生成接口文档代码

swagger文档转换为WebApiClient声明式代码

swagger-doc 让你high起来的swagger

swagger-doc 让你high起来的swagger

swagger-doc 让你high起来的swagger

Swagger(狂神说Java)(内含教学视频+源代码)