webapi文档自动生成 - kuiyu/RsCode GitHub Wiki

  services.AddSwaggerDocument(
       config => 
           {
             config.Title = "RsCode webapi文档";             
             config.Description = "这是RsCode webapi文档";
             config.DocumentName = "RsCode";
             config.Version = "1.0"; 

             config.AddSecurity("JWT", Enumerable.Empty<string>(), new NSwag.OpenApiSecurityScheme
           {
              Type=NSwag.OpenApiSecuritySchemeType.ApiKey,
              Name="Authorization",
              In=NSwag.OpenApiSecurityApiKeyLocation.Header,
              Description="Value: Bearer {Your JWT token}"
           });
           config.OperationProcessors.Add(new AspNetCoreOperationSecurityScopeProcessor("JWT"));
          }
        ) ;

  //启用中间件
  app.UseOpenApi();
  app.UseSwaggerUi3();

public void Configure(IApplicationBuilder app, IHostingEnvironment env) {

    //启用中间件为生成的 Swagger 规范和 Swagger UI 提供服务
        app.UseSwaggerUi(typeof(Startup).GetTypeInfo().Assembly, settings =>
        {
            settings.GeneratorSettings.Title = "RsWebApi项目文档";
            settings.GeneratorSettings.Description = "这是一份关于RsWebApi项目管理的文档";
            settings.GeneratorSettings.Version = "1.0";  
            settings.GeneratorSettings.DefaultPropertyNameHandling =
                PropertyNameHandling.CamelCase;
        });
      
        app.UseMvc();
    }