标签：webapi xml string void 注释 文档 swagger public

给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);

⑤运行即可

标签：webapi,xml,string,void,注释,文档,swagger,public
来源： https://www.cnblogs.com/fhzmasl/p/16242355.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。