除了Swagger UI，你还能选择 IGeekFan.AspNetCore.RapiDoc

IGeekFan.AspNetCore.RapiDoc

看到博客园上的这个文章，说了下Knife4J,评论里有人推荐RapiDoc，放了几个图，看了下，还不错。

心里 便有个想法，借着上次研究 Knife4j,封装了IGeekFan.AspNetCore.Knife4jUI。这次也实现一个 IGeekFan.AspNetCore.RapiDoc

RapiDoc

一个实现了Swagger 2.0 and OpenAPI 3.0，适用于任何框架或没有框架的API文档.我将其集成到 AspNetCore 中。

RapiDoc Custom Element for Open-API spec viewing ， IGeekFan.AspNetCore.RapiDoc 支持 .NET Core3.1 、.NET Standard2.0、.NET5.0。

特性

• 支持 Swagger 2.0 and OpenAPI 3.0
• 适用 于任何 框架，所以这里能直接配置 ASP.NET CORE
• 体积上真的更小，速度更快，大量的自定义配置项，目前自定义配置，还有待完成，当前是最基础版本v0.0.1.
• 支持本地json 文件

相关依赖项

完整特点，看RADEME RapiDoc

• rapidoc^8.4.9 (版本号)

Swashbuckle.AspNetCore

• Swashbuckle.AspNetCore.Swagger
• Swashbuckle.AspNetCore.SwaggerGen

Demo

• Basic
• RapiDocDemo
• OAuth2Integration

快速开始

安装包

以下为使用Swashbuckle.AspNetCore.Swagger底层组件

1.Install the standard Nuget package into your ASP.NET Core application.

Package Manager : 

Install-Package Swashbuckle.AspNetCore.Swagger
Install-Package Swashbuckle.AspNetCore.SwaggerGen
Install-Package IGeekFan.AspNetCore.RapiDoc

OR

CLI :

dotnet add package Swashbuckle.AspNetCore.Swagger
dotnet add package Swashbuckle.AspNetCore.SwaggerGen
dotnet add package IGeekFan.AspNetCore.RapiDoc

2.In the ConfigureServices method of Startup.cs, register the Swagger generator, defining one or more Swagger documents.

using Microsoft.AspNetCore.Mvc.Controllers
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using IGeekFan.AspNetCore.RapiDoc;

ConfigureServices

3.服务配置

   services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1",new OpenApiInfo{Title = "API V1",Version = "v1"});
    });

Configure

1. 中间件配置

app.UseSwagger();

app.UseRapiDocUI(c =>
{
    c.RoutePrefix = ""; // serve the UI at root
    c.SwaggerEndpoint("/v1/api-docs", "V1 Docs");
});

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllers();
    endpoints.MapSwagger("{documentName}/api-docs");
});

5.更多功能

为文档添加注释 在项目上右键--属性--生成

在AddSwaggerGen方法中添加如下代码

c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "SwaggerDemo.xml"),true);

最后一个参数设置为true，代表启用控制器上的注释

NSwag.AspNetCore

（请参考目录test/WebSites/NSwag.Swagger.RapiDoc）

public void ConfigureServices(IServiceCollection services)
 {
    // 其它Service
     services.AddOpenApiDocument();
 }

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
        // 其它 Use
      app.UseOpenApi();
      app.UseRapiDocUI(c =>
     {
           c.RoutePrefix = "";
           c.SwaggerEndpoint("/swagger/v1/swagger.json");
      });
}

即可使用 RapiDoc

效果图

运行项目，打开 https://localhost:5001/index.html#/home

更多配置请参考

• https://github.com/domaindrivendev/Swashbuckle.AspNetCore
• https://mrin9.github.io/RapiDoc/api.html

Github和Demo

• https://github.com/luoyunchong/IGeekFan.AspNetCore.RapiDoc

• https://api.igeekfan.cn