(转)创建WebAPI文档的3个简单步骤

摘要:
步骤1-在控制器级别上为了测试目的,创建了一个新的ApiController,名为DocumentationsController。publicclassDocumentationsController:ApiController{//GETapi/documentationpublicIEnumerableGet(){returnnewstring[]{"value1","value2"};}....在控制器操作前点击///以获取文档。//GETapi/documentation//////Thisishowwecreateadocumentation//////publicIEnumerableGet()....有关可以记录的内容的详细信息,可以按"˂"来出现IntelliSense,或转到MSDN页面。步骤2-生成属性调出项目属性页,并且设置文档的xml输出,在本例中,文档文件将是App_DataDocumentation.XML。

默认情况下,Microsoft.AspNet.WebApi.HelpPage创建的API帮助页不包含任何文档。 我们会看到所有的ApiController动作都列在No documentation available.

要启用文档,我们只需要遵循三个简单步骤。

步骤1-在控制器级别上

为了测试目的,创建了一个新的ApiController,名为DocumentationsController


public class DocumentationsController : ApiController
{
 // GET api/documentation
 public IEnumerable<string> Get()
 {
 return new string[] {"value1","value2" };
 }
....

在控制器操作前点击///以获取文档。


// GET api/documentation
/// <summary>
/// This is how we create a documentation
/// </summary>
/// <returns></returns>
public IEnumerable<string> Get()
....

有关可以记录的内容的详细信息,可以按"<"来出现IntelliSense,或转到MSDN页面

步骤2-生成属性

调出项目属性页,并且设置文档的xml输出,在本例中,文档文件将是App_DataDocumentation.XML

步骤3- HelpPage配置

若要将HelpPageConfig设置为使用我们的文档xml文件,请转到~AreasHelpPageHelpPageConfig.cs

默认情况下,config.SetDocumentationProvider语句被注释掉,使用该语句,并将DocumentationProvider的位置指向我们的xml文件:


public static void Register(HttpConfiguration config)
{
 // Uncomment the following to use the documentation from XML documentation file.
 config.SetDocumentationProvider(
 new XmlDocumentationProvider(
 HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")));

现在我们可以做一个构建和刷新api documenation页面:略

其它参考资料:https://www.cnblogs.com/AntonWang/p/5208655.html

解决swagger跨程序集问题:https://www.cnblogs.com/ricolee/p/swagger-summary.html

免责声明:文章转载自《(转)创建WebAPI文档的3个简单步骤》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇linux查看CPU高速缓存(cache)信息Linux中常用的50个命令下篇

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

相关文章

【RF库XML测试】Get Elements

Name:Get ElementsSource:XML <test library>Arguments:[ source | xpath ]Returns a list of elements in the `source` matching the `xpath`. The `source` can be a path to an XML f...

C# WebApi 接口传参详解

本篇打算通过get、post、put、delete四种请求方式分别谈谈基础类型(包括int/string/datetime等)、实体、数组等类型的参数如何传递。 一、get请求 对于取数据,我们使用最多的应该就是get请求了吧。下面通过几个示例看看我们的get请求参数传递。 1、基础类型参数 ? 1 2 3 4 5 [HttpGet] publ...

VSCode插件开发全攻略(九)常用API总结

更多文章请戳VSCode插件开发全攻略系列目录导航。 本文提炼一些常见的API使用场景供参考,本文内容有待完善。 编辑器相关 修改当前激活编辑器内容 替换当前编辑器全部内容: vscode.window.activeTextEditor.edit(editBuilder => { // 从开始到结束,全量替换 const end =...

ASP.NET Core WebApi + EF Core(实现增删改查,使用Swagger测试API)

EF有两个不同版本,即Entity Framework Core 和 Entity Framework 6 EF Core:轻量级,可扩展,跨平台,参考EF6,全新平台,学习曲线小,引入一些新功能(批量删除) EF 6 :笨重,稳定,微软已经不打算进行大版本升级,无法跨平台。 如何实现EF Core功能 1、创建ASP.NET Core Web应用程序 ...

Tweepy1_抓取Twitter数据

python机器学习-乳腺癌细胞挖掘(博主亲自录制视频)https://study.163.com/course/introduction.htm?courseId=1005269003&utm_campaign=commission&utm_source=cp-400000000398149&utm_medium=share...

百度地图API自定义地图

http://api.map.baidu.com/lbsapi/creatmap/index.html http://developer.baidu.com/map/index.php?title=webapi <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http:/...