.NET Core和Swagger 生成 Api 文档

测试/生产环境的BUG

这里更新一下在本地调试正常，在INT/PROD上抛错，错误信息为：

/**/.xml(Swagger json file) 文件找不到，在startup 里builder 的时候抛出错误。

解决方案：

编辑.csproj文件，修改输出路径，

bin$(Configuration)$(TargetFramework)\win7-x64\ChatBotApi.XML

bin$(Configuration)$(TargetFramework)\win7-x64\ChatBotApi.XML

也就是说，让环境自己选择环境变量，保证local/Int/Prod的输出路径都是对的，这样就可以将.xml文件根据环境注入到swagger中。

前言

最近写了好多Web api, 说太乱了，要整理一下，使用Swagger方式生成对应的api说明文档。
花了半天的时间，在这里记录和分享一些过程和遇到的问题。

遇到的主要问题：
1.localhost:9040/swagger/ not found

2.http://localhost:9040/swagger界面可以打开，但是can't read json file.

1.引用

这里引用了三个库，都是在Nuget上安装：
1.Microsoft.AspNetCore.StaticFiles, Version="2.0.3" , 这个package提供UI显示相关服务
2.Swashbuckle.AspNetCore, Version="2.4.0"
3.Swashbuckle.AspNetCore.SwaggerUi, Version="2.4.0"

2.打开startup.cs文件

using Swashbuckle.AspNetCore.Swagger;

在ConfigureServices集合中注入AddSwaggerGen:

public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();

// Enable CORS
services.AddCors();

//Inject Swagger
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "MyApi", Version = "v1" });
// Set the comments path for the Swagger JSON and UI.
var xmlPath = Path.Combine(AppContext.BaseDirectory, "ChatBotApi.XML");
c.IncludeXmlComments(xmlPath);
});
}

在Configure中启用中间件，允许Swagger提供服务生成json文档以及UI：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
}

app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller}/{action=Index}/{id?}");
});

app.UseStaticFiles();

// Enable middleware to serve generated Swagger as a JSON endpoint.
app.UseSwagger(c => { c.RouteTemplate = "swagger/{documentName}/swagger.json"; });

// Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
// specifying the Swagger JSON endpoint.
app.UseSwaggerUI(c =>
{
//c.RoutePrefix = "swagger/ui";
c.SwaggerEndpoint("v1/swagger.json", "ChatBotApi");
});
}