asp.net core webapi 使用swagger
swagger是一个开源的项目,如果有兴趣大家可以去github上找。
这篇文章主要是介绍如何利用swagger来展示webapi
1.创建 webapi项目,这就不用多说了
2. 添加swagger的引用
在 Dependencies右键 选择 manage nuget packages ,在 Browse中 输入Swashbuckle.AspNetCore,然后安装即可。
3. 在startup中引用该命名空间 using Swashbuckle.AspNetCore.Swagger,如图所示
4. ConfigureServices
在 startup的ConfigureServices方法中添加如图所示代码:
该图 1 部分 对生成文档的各字段描述。2 部分 是生成文档以及为接口增加注释(增加注释,可以在project属性--build--output中,将 复选框 xml documentation file 勾上即可)
5. 配置文档生成格式
useSwagger主要是定义了接口文档生成格式,而UseSwaggerUI定义了,接口访问路径以及文档访问路径,需要注意的是,参数{documentName}指的是swaggerDoc的文档名称,在此处是docV1和docV2
6. 既然是定义了两个 接口版本,那自然就是 把接口分类了,如下图
在方法上增加attribute ApiExplorerSettings(GroupName="documentName")即可,注意,名字区分大小写
看效果
1 展示了api接口路径,2展示了 接口文档路径 3可以下拉选择不同的接口文档,在此处我定义了 DemoApiV1和DemoApiV2,选择不同的版本,会自动进行切换。4.展示了V1下的接口 5展示了方法的备注信息,
下篇文章将讲解 自定义的东西 http://mp.blog.****.net/postedit/79151026
代码详见:https://github.com/AlbertBJ/aspDotNetSwagger