C#中swagger的使用
为什么要使用swagger
后端接口服务器会产生大量的接口调用,而接口的调用就必定要写接口文档,当一个项目的接口达到上百个时,人工编写接口文档会花费大量的时间,而swagger的出现则解决了这个问题。
swagger导入项目中,只需要简单的配置就可以自动化生成接口文档,同时swagger UI界面所呈现的是可交互的API文档,可以在UI界面直接完成对接口的测试、调用。
如何在asp.net项目中导入swagger
1、项目中导入swagger类库
管理项目Nuget程序包,搜索swagger并安装。
2、Startup.cs中导入配置
public void ConfigureServices(IServiceCollection services)
{
...
...
//添加swagger配置
services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1",
new Microsoft.OpenApi.Models.OpenApiInfo
{
Title = "MyBank Api Swagger Doc",
Description = "try to use swagger build api doc",
Version = "v1"
});
});
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
//加入swagger中间件
app.UseSwagger();
app.UseSwaggerUI(options=>
{
options.SwaggerEndpoint("/swagger/v1/swagger.json","MYBANK SWAGGER DOC");
});
}
3、启动项目
启动项目后,对默认的地址后加上“/swagger”即可进入swagger API文档
例:localhost:44370/swagger
4、默认启动swagger
找到API Server下的launchSettings.json文件
"profiles": {
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "swagger",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
将"launchUrl":的值设置为"swagger"即可。