C# 接口生成工具Swagger用法

1,新建一个WebApi项目

C# 接口生成工具Swagger用法

 

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

C# 接口生成工具Swagger用法

 

 

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

C# 接口生成工具Swagger用法

 

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

C# 接口生成工具Swagger用法

 

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

C# 接口生成工具Swagger用法

 

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

C# 接口生成工具Swagger用法

 

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

C# 接口生成工具Swagger用法

 

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

C# 接口生成工具Swagger用法

 

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

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

C# 接口生成工具Swagger用法

C# 接口生成工具Swagger用法

上一篇:CodeTyphon - 如何像Delphi一样,有一个一体的界面?


下一篇:Celery 运行——Windows 有点坑