第十二节:WebApi自动生成在线Api文档的两种方式

一. WebApi自带生成api文档

1. 说明

  通过观察,发现WebApi项目中Area文件夹下有一个HelpPage文件夹,如下图,该文件夹就是WebApi自带的生成Api的方式,如果该文件夹没了,可以通过Nuget安装:Microsoft.AspNet.WebApi.HelpPage ,你就会发现下图这一坨代码又回来了。

  

 

使用:http://localhost:2131/Help/Index , 即可访问生成的Api目录,如下图:

缺点:你会发现一个很坑爹的问题,方法名的注释和参数的注释均不显示,这对使用者而言,相当不放方便了。

2. 改进支持参数的注释

 (1). 选中项目,右键属性,填写生成xml文件的路径,如下图: bin\api.xml

(2). 找到 Areas/HelpPage/App_Start  目录下的HelpPageConfig.cs 文件,Register 方法,添加一行代码:

   config.SetDocumentationProvider(new XmlDocumentationProvider(AppDomain.CurrentDomain.BaseDirectory + "bin\\api.xml"));

(3). 大功告成,再次访问 http://localhost:2131/Help/Index ,发现无论是方法名还是参数名,均有描述了

 

 

 3. 小结

  上述通过改进,已经生成比较完善的Api文档了,但美中不足的是不能直接测试,当然可以整合别的控件使其支持,但比较麻烦,不如使用下面的SwashBuckle生成SwaggerUI形式的Api文档。  

 

二. 借助SwaggerUI生成api文档

 1. 通过Nuget安装 Swashbuckle (版本:5.6.0)程序集,会发现在 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件,用于配置  SwaggerUI 相关展示行为的,如下图:

 

 (2). 选中项目,右键属性,勾上xml文档文件,注意:这里默认是什么就保留什么,不要在自己改了 。如下图: bin\05-WebApiExtend.xml

 

 

(3). 在SwaggerConfig.cs文件中 搜索 【  c.IncludeXmlComments(GetXmlCommentsPath());  】,在这句话的下面新增一句代码:

  c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "bin\\05-WebApiExtend.xml");

(4). 大功告成,访问:http://localhost:2182/swagger/ui/index  ,即可查看生成Api文档。

 

 

 

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/438267.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

JVM 组成部分

JVM可以分为3大部分:类加载器,运行时数据区和执行引擎。 类加载器负责加载.class 文件 运行时数据区负责存放.class 文件,分配内存。运行时数据区又分为5个部分: 方法区:负责存放.class 文件,方法区里有一块区域是运…

第十三节:Asp.Net Core WebApi基础总结和请求方式-第十八节

一. 基础总结 1.Restful服务改造 Core下的WebApi默认也是Restful格式服务,即通过请求方式(Get,post,put,delete)来区分请求哪个方法,请求的URL中不需要写方法名。 但是我们不喜欢这种方式,所以我们将默认的路由规则 [Route("api/[contr…

第十四节:Asp.Net Core WebApi生成在线文档-第十九节

一. 基本概念 1.背景 使用 Web API 时,了解其各种方法对开发人员来说可能是一项挑战。 Swagger 也称为OpenAPI,解决了为 Web API 生成有用文档和帮助页的问题。 它具有诸如交互式文档、客户端 SDK生成和 API 可发现性等优点,目前有两种实现方…

第十五节:Asp.Net Core MVC和WebApi路由规则的总结和对比-第二十节

一. Core Mvc 1.传统路由 Core MVC中,默认会在 Startup类→Configure方法→UseMvc方法中,会有默认路由:routes.MapRoute("default", "{controllerHome}/{actionIndex}/{id?}"); 等价于 app.UseMvcWithDefaultRoute(); …

String、StringBuffer和StringBuilde的区别

StringBuffer 和 StringBuilder 类提供了操作字符串的方法。 String为字符串常量,即String对象一旦创建之后该对象是不可更改,final 修饰,可以被不同线程共享,是线程安全的。在涉及多线程操作中不需要同步操作。 StringBuilder和…

第四节:Task的启动的四种方式以及Task、TaskFactory的线程等待和线程延续的解决方案

一. 背景 揭秘: 在前面的章节介绍过,Task出现之前,微软的多线程处理方式有:Thread→ThreadPool→委托的异步调用,虽然也可以基本业务需要的多线程场景,但它们在多个线程的等待处理方面、资源占用方面、线程…

Java中对字符串的操作

字符串反转 StringBuffer 或 StringBuilder 的 reverse方法 String s1 new StringBuilder(str).reverse().toString(); String s3 new StringBuffer(str).reverse().toString(); System.out.println(s1);//cba System.out.println(s3);//cbaList集合拼接成逗号分隔的字符串…

第五节:Task构造函数之TaskCreationOptions枚举处理父子线程之间的关系。

一. 整体说明 揭秘: 通过F12查看Task类的源码(详见下面的截图),发现Task类的构造函数有有一个参数为:TaskCreationOptions类型,本章节可以算作是一个扩展章节,主要就来研究TaskCreationOptions类的作用。 该类主要用来…

List,Map,实体类,字符串相互转换

添加依赖 <dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.7</version></dependency> List,实体类字符串想换转换 package Map;import com.alibaba.fastjson.*; import dto.Pers…

第六节:深入研究Task实例方法ContinueWith的参数TaskContinuationOptions

一. 整体说明 揭秘&#xff1a; 该章节的性质和上一个章节类似&#xff0c;也是一个扩展的章节&#xff0c;主要来研究Task类下的实例方法ContinueWith中的参数TaskContinuationOptions。 通过F12查看TaskContinuationOptions的源码&#xff0c;知道主要有这么几个参数&#xf…

java8 stream流操作集合交集,差集,并集,过滤,分组,去重,排序,聚合等

测试对象 public class Person {private String name;private Integer age;private Integer weight;public Person() {}public Integer getWeight() {return weight;}public void setWeight(Integer weight) {this.weight weight;}public Integer getAge() {return age…

第七节:利用CancellationTokenSource实现任务取消和利用CancellationToken类检测取消异常。

一. 传统的线程取消 所谓的线程取消&#xff0c;就是线程正在执行的过程中取消线程任务。 传统的线程取消&#xff0c;是通过一个变量来控制&#xff0c;但是这种方式&#xff0c;在release模式下&#xff0c;被优化从cpu高速缓存中读取&#xff0c;而不是从内存中读取&#xf…

start()和run()的区别

start方法&#xff1a; 通过该方法启动线程的同时也创建了一个线程&#xff0c;真正实现了多线程。无需等待run()方法中的代码执行完毕&#xff0c;就可以接着执行下面的代码。此时start()的这个线程处于就绪状态&#xff0c;当得到CPU的时间片后就会执行其中的run()方法。这个…

c#中的BeginInvoke和EndEndInvoke 摘要

摘要 异步这东西&#xff0c;真正用起来的时候&#xff0c;发现事情还是挺多的&#xff0c;最近在项目中用到了异步的知识&#xff0c;发现对它还是不了解&#xff0c;处理起来&#xff0c;走了不少弯路。觉得还是补一补还是很有必要的。 MSDN原文地址&#xff1a;https://ms…

关于@DateTimeFormat 和 @JsonFormat 注解

两个参数都是针对日期格式化做处理 1.入参格式化DateTimeFormat 传入参数是 String 类型,接收的参数Date 类型&#xff0c;类型无法转换。 使用 Spring 的 DateTimeFormat 注解格式化参数 传入参数要是日期格式的String 类型 例如:"2021-10-01" pattern &quo…

NET 提供了执行异步操作的三种模式

1.APM模式简介 在.net1.x的版本中就可以使用IAsyncResult接口实现异步操作&#xff0c;但是比较复杂&#xff0c;这种称之为异步编程模型模式 (Asynchronous Programming Model, APM)&#xff0c;也称为IAsyncResult模式 在这种APM模式下&#xff0c;一个同步操作XXX需要定义B…

java实体类属性非空判断工具类

import java.util.Collection; import java.util.HashMap; import java.util.Map; import java.util.Map.Entry;public class CheckParametersUtil {Map<String, Object> map new HashMap<>();/*** 添加需要校验的参数* param object 实参* param parameterName 参…

第八节:Task的各类TaskTResult返回值以及通用线程的异常处理方案。

一. Task的各种返回值-Task<TResult> PS&#xff1a; 在前面章节&#xff0c;我们介绍了Task类开启线程、线程等待、线程延续的方式&#xff0c;但我们并没有关注这些方式的返回值&#xff0c;其实他们都是有返回值的Task<TResult>&#xff0c;然后可以通过Task的…

第九节:深究并行编程Parallel类中的三大方法 (For、ForEach、Invoke)和几大编程模型(SPM、APM、EAP、TAP)

一. 并行编程 1. 区分串行编程和串行编程 ①. 串行编程&#xff1a;所谓的串行编程就是单线程的作用下&#xff0c;按顺序执行。(典型代表for循环 下面例子从1-100按顺序执行) ②. 并行编程&#xff1a;充分利用多核cpu的优势&#xff0c;同时开启多个线程并行执行。(典型代表…

Mybatis四种分页方式

1.数组分页 查询出全部数据&#xff0c;然后再list中截取需要的部分。 mybatis接口 List<Student> queryStudentsByArray(); xml配置文件 <select id"queryStudentsByArray" resultMap"studentmapper">select * from student</select&…