7webapi中的swagger文档服务注释
给api的swagger文档服务写入注释如:
①创建一个控制器
在代码中使用标准的方法、类注释。
namespace WebApplication1.Controllers
{
/// <summary>
/// 整站首页
/// </summary>
[Route("[controller]")]
[ApiController]
public class HomeController : ControllerBase
{
/// <summary>
/// 得到名字
/// </summary>
/// <param name="id">用户id</param>
/// <returns>字符串类型的名字</returns>
[HttpGet]
public string GetName(string id)
{
return "hello " ;
}
/// <summary>
/// 插入
/// </summary>
[HttpPost]
public void Insert()
{}
/// <summary>
/// 修改信息
/// </summary>
/// <param name="name">用户名</param>
[HttpPut]
public void Put(string name)
{}
}
}
②项目右键-->属性-->生成。勾上xml文档文件,它会生成基于xml的注释:
一般在本地调试可以用绝对路径
③编译生成
④在已添加的依赖服务swagger服务里添加新的配置
c.IncludeXmlComments("WebApplication1.xml", true);