C# 接口生成工具Swagger用法

摘要:
手动写入c.IncludeXmlComments(GetXmlCommentsPath());在控制器中添加TestController.cssusingSystem;使用System.Linq;使用System.Net.Http;///获取列表///<paramname=“id”>

1,新建一个WebApi项目

C# 接口生成工具Swagger用法第1张

 2,项目打开之后,引用--》右键--》管理NuGet程序包

C# 接口生成工具Swagger用法第2张

3,按账好之后,右键项目--》属性--》生成  输出勾选:XML文档文件,如果没有自动填充好路径,需要自己填写一下,文件名可以自己取

C# 接口生成工具Swagger用法第3张

 4,打开App_Start文件夹下的SwaggerConfig.cs文件,新增一个如下方法:

C# 接口生成工具Swagger用法第4张

 5,搜索GetXmlCommentsPath,下面能搜到已经注释了,自己把注释放开,要是没搜到,就自己手动写一下c.IncludeXmlComments(GetXmlCommentsPath());注意要写在register方法里面

C# 接口生成工具Swagger用法第5张

 6,打开valuescontroller,自己写一些注释

C# 接口生成工具Swagger用法第6张

 7,运行项目,在根路径后面直接加swagger,就会自动跳转到文档,如:http://localhost:8970/swagger,能看到我们写的一些注释

C# 接口生成工具Swagger用法第7张

 8,在实际应用中,完全使用webapi的restful风格的api设计是比较少见的,请求方式一般也只使用get请求和post请求,所以我们做一些修改,使用的是类似restful风格的api设计,修改一下webapi的路由配置

C# 接口生成工具Swagger用法第8张

 9,在Controllers中添加一个TestController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Web;
using System.Web.Http;

namespace 接口生成工具Swagger.Controllers
{
    public class TestController:ApiController
    {
        /// <summary>
        /// get列表
        /// </summary>
        /// <returns></returns>
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

        /// <summary>
        /// get请求
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        public string Get(int id)
        {
            return "value";
        }

        /// <summary>
        /// post请求
        /// </summary>
        /// <param name="token"></param>
        /// <param name="model"></param>
        /// <returns></returns>
        //public HttpResponseMessage Post(string token, [FromBody]UserModel model)
        //{
        //    CookieHelper.SetUserCookie(model);
        //    string strResult = "{"UserName": "" + model.UserName + "", "Pwd": "" + model.Pwd + ""}";
        //    return new HttpResponseMessage(System.Net.HttpStatusCode.OK)
        //    {
        //        Content = new StringContent(strResult, Encoding.UTF8, "text/json")
        //    };
        //}
    }
}

  10,运行 输入http://localhost:64956/api/Test/Get

C# 接口生成工具Swagger用法第9张

 参考:https://segmentfault.com/a/1190000019013402

免责声明:文章转载自《C# 接口生成工具Swagger用法》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇adb命令——简单常用命令介绍:, 获取设备列表及设备状态:adb devices———— 获取设备的状态:adb get-state程序设计原则(总结)下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

原!struts安全漏洞,由2.3.37版本升级至2.5.22

漏洞描述 Apache Struts2框架是一个用于开发Java EE网络应用程序的Web框架。Apache Struts于2020年8月13日披露 S2-059 Struts 远程代码执行漏洞(CVE-2019-0230),在使用某些tag等情况下可能存在OGNL表达式注入漏洞,从而造成远程代码执行,风险极大。阿里云应急响应中心提醒Apache Stru...

eventlet的学习

转自:http://bingotree.cn/?p=281 官方网站:http://eventlet.net/ 之前小秦我写了篇python中协程和yield的文章,这里小秦我再总结一下eventlet中比较重要的几个知识点。 1.安装方法: 1 [root@COMPUTE02 ~]# pip install eventlet 2.基础知识及优点 ev...

redis在linux上部署,Redis服务器搭建/配置/及Jedis客户端的使用方法(java语言)

转自http://my.oschina.net/gccr/blog/307725?fromerr=yX8AifBq   Redis服务器搭建 安装 在命令行执行下面的命令: $ wget http://download.redis.io/releases/redis-2.8.13.tar.gz $ tar xzf redis-2.8.13.tar.g...

HTML调用servlet(一)

1.页面的数据表单 在使用Servlet处理用户请求之前,先准备一个页面,该页面用来提供数据表单。数据表单就是HTML中的<form>...</form>部分,当用户单击Submit按钮提交表单之后,表单中包含的一些变量(或者成为字段)将会被发送到服务器端进行处理。下面编写一个HTML文件,文件代码如下: add.html &l...

10mybatis分页技术

maven 手动安装jar包方法 mvn.cmd 在哪里 e:mavenin 目录下 mvn install:install-file -DgroupId=com.oracle -DartifactId=ojdbc14 -Dversion=10.2.0.2.0 -Dpackaging=jar -Dfile=E:oracleojdbc14-10...

TortoiseGit 使用教程

前言   作为一个软件开发人员,不可能不知道Git。Git作为一个复杂的版本控制系统,命令之多,即使经常使用,一些命令也记不住,一般只记住几个常用的命令,不是所有使用Git命令行都是高效的。本教程不讲Git命令,而是先让你用上git,再去学习git。本教程应该称作TortoiseGit入门指南。因为下面要借助一个图形化的软件,TortoiseGit来操作g...