定製swagger的UI

時間 2019-11-30

標籤定製 swagger 简体版

原文原文鏈接

https://github.com/RSuter/NSwag/wiki#ways-to-use-the-toolchaingit

Customizations

Swagger generation:github

You can customize the Swagger generator with the following extension points of NSwag:json

Document Processors and Operation Processors

https://github.com/RSuter/NSwag/wiki/OWIN-Middlewareapi

Package: NSwag.AspNet.Owin (.NET 4.5+)

The NuGet package provides extension methods to register the NSwag ASP.NET OWIN middlewares:app

The middlewares are based on WebApiToSwaggerGenerator - the old reflection based ASP.NET Core and ASP.NET generatoride

Swagger only:visual-studio

app.UseSwagger(assembly, configure): Registers the Swagger generator on a given route

Swagger and Swagger UI: (用了這個，就不能用上面的，是衝突的)ui

app.UseSwaggerUi(assembly, configure): Registers the Swagger generator and Swagger UI v2.x on the given routes
app.UseSwaggerUi(configure): Registers only the Swagger UI on the given route
app.UseSwaggerUi3(configure): Registers the Swagger generator and Swagger UI v3.x on the given routes
app.UseSwaggerReDoc(configure): Registers the Swagger generator and ReDoc on the given routes

The default routes to access the Swagger specification or Swagger UI:this

Swagger JSON: http://yourserver/swagger/v1/swagger.json
Swagger UI: http://yourserver/swagger

1. Install required NuGet packages

First, you need to install the required NSwag NuGet packages.spa

2. Register the middleware

OWIN Startup Class Detection

public class Startup { public void Configuration(IAppBuilder app) { var config = new HttpConfiguration(); app.UseSwaggerUi(typeof(Startup).Assembly, settings => { // configure settings here // settings.GeneratorSettings.*: Generator settings and extension points // settings.*: Routing and UI settings }); app.UseWebApi(config); config.MapHttpAttributeRoutes(); config.EnsureInitialized(); } }

Configure the routing of the Swagger requests

There are two ways to do this:

自定義

Post process the served Swagger specification

It is possible to transform the generated Swagger specification before it is served to the client:

app.UseSwagger(typeof(Startup).Assembly, settings => { settings.PostProcess = document => { document.Info.Description = "My description"; }; });

If you want to implement more reusable code, you can also implement Document Processors and Operation Processors.

UseSwagger和UseSwaggerUi3只能用一個

app.UseSwaggerUi3(typeof(Startup).Assembly, settings =>
            {
                // configure settings here
                // settings.GeneratorSettings.*: Generator settings and extension points
                // settings.*: Routing and UI settings
                settings.GeneratorSettings.DefaultUrlTemplate = "api/{controller}/{action}/{id}";
                settings.PostProcess = document =>
                {
                    document.Info.Title = "My Services";
                    document.Info.Version = "1.5";
                    document.Info.Contact = new SwaggerContact {Name = "My team", Email = "test@qq.com" };
                };
            });