使用Swagger记录ASP.NET Web API

使用Swagger记录ASP.NET Web API

原文作者:Rob Sanders

原文地址:https//dzone.com/articles/documenting-a-aspnet-web-api-with-swagger

在本文中,我将介绍一些可以为ASP.NET Web API生成文档的方法。除非您从未生成过Web API网站,否则您将会意识到,默认模板已经包含了为您可能实现的API 生成文档的功能,其中的一个示例位于authme.ws

入门

没有什么比一对夫妇的文章更多的已写入有关如何生成使用扬鞭用于ASP.NET的Web API文档(这里面的NuGet包称为Swashbuckle,你可以轻松地集成),但我需要的东西动-其实,我需要生成表示我们提升到生产(即时间点)的静态文档,因为它需要提供给审计。

传统的文档(例如Sandcastle Help File Builder)显然不可行,因为它记录了托管代码,而不是更重要的API接口和运行时模型。

幸运的是,有一个工具集称赞Swagger,称为Swagger codegen,它生成客户端代码来使用API​​,对于我来说 - 生成静态HTML的能力(礼貌[1])。不幸的是,我找不到Swagger Codegen ,所以我咬紧牙关,使用Maven和最新的JDK 从源代码编译Java二进制文件。

你需要什么

您需要能够生成可以在IIS或IIS Express中启动的Web API站点。理想情况下,你要做的是将前面提到的Swashbuckle NuGet包集成到你现有的(或新的)Web API项目中。安装完成后,您只需更改项目设置即可生成注释XML文件(不是强制性步骤,但非常有用 - 请参阅下图),然后配置插入App_Startup文件夹下项目的SwaggerConfig.cs文件。

image.png

本文的版权归 恒恒 所有,如需转载请联系作者。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏流柯技术学院

Python自动化测试工具Splinter简介和使用实例

Splinter 快速介绍 官方网站:http://splinter.cobrateam.info/ 官方介绍: Splinter is an open ...

832
来自专栏FreeBuf

挖洞经验 | Facebook的手机扫码登录漏洞

Facebook最近推出了忘记密码的手机登录功能,我发现该功能中的二维码扫描存在漏洞,可以利用其进行CSRF攻击,劫持其它Facebook账户。 ? 当我的手机...

2258
来自专栏每日一篇技术文章

weex-19-refresh组件

661
来自专栏程序员互动联盟

浏览器开发系列第三篇:chromium代码目录结构

上两篇介绍了下载源码和编译源码,这次主要介绍chromium的源码目录结构,我也是通过源码和官网结合来跟大家说,如果有说的不准确的,欢迎交流。 另外...

4027
来自专栏逸鹏说道

用Python、NetCore、Shell分别开发一个Ubuntu版的定时提醒

用Python、NetCore、Shell分别开发一个Ubuntu版的定时提醒(附NetCore跨平台的两种发布方式) 

1619
来自专栏葬爱家族

Android高德之旅(6)

我们看惯了高德地图,似乎已经习惯了它的ui,认为河流就是蓝色的,土地就是灰色的,交通路网就是黄色的。其实这个ui也是可以改的。今天就来使用下自定义地图ui。

872
来自专栏GIS讲堂

jquery自定义插件——window的实现

932
来自专栏前端儿

【转】http-equiv="X-UA-Compatible" 设置IE浏览器兼容模式详解

文件兼容性用于定义让IE如何编译你的网页。此文件解释文件兼容性,如何指定你网站的文件兼容性模式以及如何判断一个网页该使用的文件模式。

1221
来自专栏小詹同学

Python爬虫系列之一——我有100万?

高中生都开始写爬虫了,可见爬虫有多热门,一个某某985高校的研究生不学习学习爬虫实在是有些落伍啦~ ? 一、网络爬虫和url ...

3526
来自专栏C语言及其他语言

【项目源码】C语言模拟彩票系统(VC6环境)

各位,今天继续给大家放C语言的源码,这次是用C语言实现的模拟彩票系统,很好玩哦~看图: ? 功能选择: ? 用户可以选择机选还是自选,完成选号,然后可以兑奖~...

2636

扫码关注云+社区