asp.net webapi 简单使用Swagger

标签: asp.net webapi  swagger  asp.net  asp.net webapi  swagger

什么是Swagger

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,是一个在线的接口编辑文档,该文档描述了 API 的各种状态。

如何使用Swagger

新建Asp.net Webapi项目,使用nuget添加对Swagger的引用。
在这里插入图片描述
安装成功后可以看到在App_Start文件中创建了两个类:SwaggerNet和SwaggerConfig。
运行项目后会发现报错:在这里插入图片描述
我们只需要在SwaggerNet类上面的两行代码注释掉即可运行成功。

[assembly: WebActivator.PreApplicationStartMethod(typeof(Swagger.App_Start.SwaggerNet), "PreStart")]
[assembly: WebActivator.PostApplicationStartMethod(typeof(Swagger.App_Start.SwaggerNet), "PostStart")]

再次运行项目,在地址栏后面输入Swagger即可
在这里插入图片描述

对接口添加描述信息

右键项目→属性→生成→选中下方的 “XML文档文件” 然后保存
在这里插入图片描述
在SwaggerConfig类中,EnableSwagger的时候添加下面XML解析
在这里插入图片描述
在ValuesController里添加代码注释

/// <summary>
       /// 根据id获取数据
       /// </summary>
       /// <param name="id">编号</param>
       /// <returns></returns>
        public string Get(int id) {
            return "value";
        }

        // POST api/values
        /// <summary>
        /// 修改数据
        /// </summary>
        /// <param name="value"></param>
        public void Post([FromBody]string value) {
        }

        // PUT api/values/5
        public void Put(int id, [FromBody]string value) {
        }

        // DELETE api/values/5
       /// <summary>
       /// 删除数据
       /// </summary>
       /// <param name="id">编号</param>
        public void Delete(int id) {
        }

再次运行,效果如下
在这里插入图片描述

版权声明:本文为gods_boy原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/gods_boy/article/details/106844006