.NetCore学习笔记：六、Swagger API接口文档工具

Swagger一个优秀的Api接口文档生成工具。Swagger可以可以动态生成Api接口文档，有效的降低前后端人员关于Api接口的沟通成本，促进项目高效开发。

1、使用NuGet安装最新的包：Swashbuckle.AspNetCore。

 2、编辑项目文件（NetCoreTemplate.Web.csproj），配置

 <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'"> <DocumentationFile>bin\Debug\netcoreapp3.1\NetCoreTemplate.Web.</DocumentationFile> <OutputPath>bin\Debug\netcoreapp3.1\</OutputPath> </PropertyGroup> <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'"> <DocumentationFile>bin\Release\netcoreapp3.1\NetCoreTemplate.Web.</DocumentationFile> <OutputPath>bin\Release\netcoreapp3.1\</OutputPath> </PropertyGroup>

3、在项目中注册Swagger，添加一个文档信息和导入

// 注册Swagger服务services.AddSwaggerGen(c =>{ // 添加文档信息 c.SwaggerDoc("v1", new OpenApiInfo { Title = "NetCoreTemplate Api", Version = "v1" }); //导入

4、添加Swagger中间件和Page UI。

app.UseSwagger();app.UseSwaggerUI(c =>{ c.SwaggerEndpoint("/swagger/v1/swagger.json", "NetCoreTemplate V1");});

这样配置就完成了，启动程序检验一下成果。

 

 

源码地址：https://github.com/letnet/NetCoreDemo

 

.NetCore学习笔记：六、Swagger API接口文档工具西农、 google correlate、 联动优势电子商务、 速卖通将上线"搜索作弊"处罚展示功能，维护平台市场秩序！、 稳居3C类前三的它竟靠这3招在东南亚C位出道！、 eBay+美国站：这些低单价产品帮你卖卖卖！快上车！、 上海：狮子座的奢侈享受(图)_上海市旅游、 杭州：金牛座的游玩胜地(图)_杭州市旅游、 鼓浪屿：巨蟹座的小资情调(图)_厦门市旅游、