WebApi生成文档
2024-09-04 04:28:22
本文包括两个部分:
- webapi中使用swagger
- 修改webapi的路由和默认参数
- WebApi中使用swagger
项目打开之后,选择 引用,右键,管理NuGet程序包
浏览,搜索swagger,选择第一个swashbuckle,安装
安装好之后,右键项目,选择属性,生成,在下面的输出那里勾选:XML文档文件,如果没有自动填充好路径,需要自己填写一下,文件名可以自己
打开App_Start文件夹下的SwaggerConfig.cs文件,新增一个如下方法:
private static string GetXmlCommentsPath()
{
return System.String.Format(@"{0}\bin\Coldairarrow.WebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory);
}搜索GetXmlCommentsPath,下面能搜到已经注释了,自己把注释放开,要是没搜到,就自己手动写一下c.IncludeXmlComments(GetXmlCommentsPath());注意要写在register方法里面
运行项目,在根路径后面直接加swagger,就会自动跳转到文档,如:http://localhost:13520/swagger/ui/index,能看到我们写的一些注释
最新文章
- jQuery初探 jQuery选取和操纵元素的特点
- 开始python学习了
- 一步一步搭建客服系统 (4) 客户列表 - JS($.ajax)调用WCF 遇到的各种坑
- linux消息队列的使用及内核实现原理
- Android 如何设置默认语言
- Java方法重载
- 对cnblogs.com用户体验的评价
- C# winform 最小化到电脑右下角
- SpringMVC控制器配置文件
- c语言学习之基础知识点介绍(二十):预处理指令
- 使用ChineseLunisolarCalendar 对象由年份获得生肖名,Datetime.now.tostring获得星期几
- Echarts自适应浏览器大小
- Docker常用名称
- Linux 下配置Nginx,MySql,php-fpm开机启动
- python中的私有变量
- [P1441]砝码称重 (搜索+DP)
- Subarray Sums Divisible by K LT974
- mysql之 安装(Mac)
- 计算完成率 SQL
- 大数据竞赛平台Kaggle案例实战