asp.netcore swagger的使用 来自动生成API文档
一. 安装nuget包
搜索并安装:Swashbuckle.AspNetCore的包
结果如图所示:
二.开始使用
1.在Startup文件的 ConfigureSevers 里面添加如下代码:
services.AddSwaggerGen(option =>
{
option.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});
这里需要添加
using Swashbuckle.AspNetCore.Swagger;
2.在Startup文件的Configure 里面添加如下代码:
app.UseSwagger();
app.UseSwaggerUI(option =>
{
option.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
三.启动项目即可使用。
默认路由:https://localhost:【端口号】/swagger
如下图所示:
注意事项:
所有Controller和方法必须要有 Route ,也可以简写 [HttpGet("test")].如下图所示
如果不写会出现错误: Not Found /swagger/v1/swagger.json 如下图所示