.net core 3.0 之Api文档生成 NSwag框架

前言

是另一个用于生成 Swagger 文档并将 Swagger UI 或 ReDoc 集成到 ASP.NET Core Web API 中的开源项目。 此外，NSwag 还提供了为 API 生成 C# 和 TypeScript 客户端代码的方法。

功能

1.能够使用 Swagger UI 和 Swagger 生成器。

2.灵活的代码生成功能。

安装

VSCode：

dotnet add package NSwag.AspNetCore

VS:

Install-Package NSwag.AspNetCore

使用方式非常简单

Startup.cs

添加引用

using NSwag.AspNetCore;

ConfigureServices 方法中添加

services.AddSwaggerDocument();

Configure 方法中添加

//注册UI插件
app.UseOpenApi();
app.UseSwaggerUi3();

注意固定地址为：

• http://localhost:<port>/swagger，以查看 Swagger UI。

• http://localhost:<port>/swagger/v1/swagger.json，以查看 Swagger 规范。

然后跑起来：

然后我们就可以看到我们写的Api了，以及测试api（自己尝试一下就OK了）

知识扩展

更多详情请参考：

https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-3.1&tabs=netcore-cli

Demo：

https://github.com/aspnet/AspNetCore.Docs/tree/master/aspnetcore/tutorials/web-api-help-pages-using-swagger/samples/2.1/TodoApi.NSwag