ASP.NET MVC 5使用Swagger生成API文档

一、安装

新建一个没有身份验证的mvc项目 - SwaggerMvc5Demo,然后添加一个名为Remote(自定义)且包含基础读写(不想手写)的ApiController

 

开源地址:https://github.com/domaindrivendev/Swashbuckle

使用以下方法来添加 Swashbuckle:

  • 从“程序包管理器控制台”窗口:Install-Package Swashbuckle -Version 5.6.0
  • 从“管理 NuGet 程序包”对话框中:
    • 右键单击“解决方案资源管理器” > “管理 NuGet 包”中的项目
    • 将“包源”设置为“nuget.org”
    • 在搜索框中输入“Swashbuckle”
    • 从“浏览”选项卡中选择“Swashbuckle”包,然后单击“安装”

 

二、配置

1.项目属性->勾选生成xml文档文件

2.添加导航链接

在_Layout.cshtml文件中添加代码

<li>@Html.ActionLink("Swagger Help", "", "Swagger", new { area = "" }, null)</li>

3.修改SwaggerConfig.cs文件

 安装完成后,在文件夹App_Start自动生成一个配置文件 swagger.config。这里可以做多版本控制,定义扩展功能,自定义显示ui的样式脚本,可以配置过滤、权限等。

例如:

(1)为接口添加xml注释

string path = string.Format("{0}/bin/SwaggerMvc5Demo.XML", System.AppDomain.CurrentDomain.BaseDirectory);

c.IncludeXmlComments(path);

使用前

使用后

(2)使用特性 [Obsolete]

在config中 开启 c.IgnoreObsoleteProperties();

 

 

 

 

三、调用

1.直接调用

只要输入参数id,即可调用,非常方便

2.AutoRest

AutoRest (https://github.com/Azure/AutoRest), 简单来说,就是一个EXE工具,可以根据Swagger的结构生成服务的客户端,这个客户端可以让你像调用本地方法一样调用服务,方法内部包装了Http请求。 

详细教程请看 https://www.cnblogs.com/Leo_wl/p/5982882.html

 

扩展:ABP集成swagger

http://www.cnblogs.com/wer-ltm/p/5776024.html

 

参考文章:

http://www.cnblogs.com/oneapm/p/5390303.html

http://blog.csdn.net/yuchen_0515/article/details/51762958

 

 

时间: 2024-08-03 08:15:38

ASP.NET MVC 5使用Swagger生成API文档的相关文章

.Net魔法堂:提取注释生成API文档

一.前言   在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险.   对于.Net,我们可以直接将类.方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量.   下面我们使用.Net唯一的注释生成API文档工具--Sandcastle和Sandcastle Help File Builder来实现API文档自动化吧!

YUIDoc example代码高亮错误、生成API文档目录不按源文件注释顺序

1.如果发现yuidoc命令用不了,那就重装nodejs吧    昨天不知道是清扫电脑的原因,yuidoc命令用不了(命令不存在),也没有找到好的解决方法,怒重装YUIDoc也不行.最后想了想,怒重装了nodejs,再装回YUIDoc,发现又可以了,原因还没找到. 2.YUIDoc的theme中的simple模板,sidebar.handlebar有写错.    里面属性遍历的properties被写成了events 3.YUIDoc example代码高亮错误的解决方法   使用过YUIDoc

ASP.NET技巧:根据xsd生成xml文档

asp.net|xml|技巧|生成xml 现在有很多的xml工具软件都能根据xsd文件书写出xml文档,.net 没有实现此方法,如是我写了几个浏览.校验.和创建xml的方法全部代码如下: using System;using System.Data;using System.Configuration;using System.Web;using System.Web.Security;using System.Web.UI;using System.Web.UI.WebControls;us

RESTful API 文档生成神器 WisdomTool REST Client

Wisdom Tool REST Clientsupports automated testing and automatically generating RESTful API document based on history cases. Wisdom Tool REST Client可以自动化测试RESTful API 接口,同时,基于测试过的历史数据,可以自动生成API文档. 工具地址: https://github.com/wisdomtool/rest-client

Clojure世界:API文档生成

    继续Clojure世界之旅,介绍下我今天的探索成果,使用clojure生成clojure项目的API文档.在java里,我们是利用javadoc生成API文档,各种build工具都提供了集成,例如maven和ant都提供了javadoc插件或者task.在Clojure世界里,同样有一系列工具帮助你从源码中自动化生成API文档.今天主要介绍三个工具.不过我不会介绍怎么在clojure里写doc,具体怎么做请看一些开源项目,或者直接看clojure.core的源码.     首先是codo

Java多种方式动态生成doc文档_java

本来是要在Android端生成doc的(这需求...),最后方法没有好的方法能够在Android上做到完美,最后还是只能搬迁到服务器.不浪费,还是记录下各框架不支持Android的原因以及他们的特点.Java相关的这类框架还是很多的,有几个还不错,可惜要么不支持Android,要么要收费还价格不低.  经过亲自测试,Android不支持Java的awt很多包不能直接在Android上用,FreeMarker挺不错的,能生成复杂漂亮的doc,可惜不支持Android.用POI在Android上能运

巧用ASP实现在线生成PDF文档

    在开始讲解ASP实现在线生成PDF文档之前我们先了解一下PDF的历史,了解了某个东西,知道他的作用性以及重要性,再去学习该ASP程序相信效果一定不一样.     Adobe PDF格式已经变成很多机构和公司进行跨平台制表的通用媒体格式.尽管我不是这个产品的狂热痴迷者,却不得不接受这样一个事实:用这个格式产生一个协定可能会比用Word还要好.           由于在一家雇用公司工作,我已经把我们所有早期的软件写成能在Internet上运行,这样我们就能和小的子公司共享公用数据库了.然而

ASP生成Word文档的又一方法

word 在网上,利用Asp生成Word文档的方法实在不少,最常见到的方法就是利用Word生成.dot的文档,再用Asp向.dot文档中传递宏,这种方法虽好,但实现起来非常复杂,而且不能循环生成表格. 在实际应用中,我总结出来一种新的生成Word文件的方法,生成的Word文件有页眉.页角,现拿出一例与大家探讨. 实现: 我的解决办法,用Word XP(其他版本还没有试过)制作表格,将做好的Word表格转换为HTML文档,在用ASP控制转换后HTML文档. 页眉.页角的解决办法,在转换带Word页

asp.net中动态生成word文档,怎么给导出的word中标题栏的加个背景颜色。

问题描述 asp.net中动态生成word文档,怎么给导出的word中标题栏的加个背景颜色. asp.net中动态生成word文档,怎么给 导出 的word中标题栏的加个背景颜色.