使用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

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

发表于

恒恒的专栏

1 篇文章2 人订阅

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏梁源的专栏

React Native 用JavaScript开发移动应用 - 思维导图

1334
来自专栏逸鹏说道

02.Web大前端时代之:HTML5+CSS3入门系列~H5结构元素

Web大前端时代之:HTML5+CSS3入门系列:http://www.cnblogs.com/dunitian/p/5121725.html 1.结构元素 可...

2595
来自专栏娱乐心理测试

xcode 9以后导入图片遇到显示不出的问题

1162
来自专栏Angular&服务

Angular2 页面的生命周期

当被绑定的输入属性的值发生变化时调用,首次调用一定会发生在 ngOnInit之前。

1022
来自专栏LIN_ZONE

php 识别二维码(转载)

最开始找的方法是一个叫 php-zbarcode 的扩展,自己照着网上的安装步骤安装了 ImageMagick 和 zbar ,但编译 php-zbarcode...

793
来自专栏.Net移动开发

.Net语言 APP开发平台——Smobiler学习日志:在手机应用中开发蛛网表格

最前面的话:Smobiler是一个在VS环境中使用.Net语言来开发APP的开发平台,也许比Xamarin更方便

591
来自专栏张善友的专栏

ASP.NET 5 Beta 7 版本

在 VS2015 发布的同时,微软也发布了 ASP.NET 5 的路线图(详见 ASP.NET 5 Schedule and Roadmap : https:/...

1858
来自专栏小俊博客

随机图片API

本系统采用HTTPS直接获取资源,比HTTP更快捷,不过由于是1M小水管可能会有点慢

2004
来自专栏React Native开发圈

React Native下载打开pdf文件

首先下载pdf文件到本地,react-native-pdf-view组件现在只能支持显示手机本地pdf。

871
来自专栏施炯的IoT开发专栏

课程上线 -“新手入门 : Windows Phone 8.1 开发”

经过近1个月的准备和录制,“新手入门 : Windows Phone 8.1 开发”系列课程已经在Microsoft 虚拟学院上线,链接地址为:http://w...

1738

扫码关注云+社区