使用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 条评论
登录 后参与评论

相关文章

来自专栏liulun

用Nim语言开发windows GUI图形界面程序

前言 本文得到了“樂師”的大力支持, 我们一起调试程序到深夜,要是没有他的帮忙, 我不知道要多久才能迈过这道坎, 另外“归心”还有其他人也提供了帮助, 他们都来...

41750
来自专栏Zachary46

Android直接用手机打包apk!

本人用的是Mac,以下操作都是在Mac环境下配置的,Windows环境的配置移步到Android使用Jenkins自动化构建测试打包apk

47730
来自专栏逸鹏说道

后渗透攻防的信息收集

1.0前言 后渗透常见的信息收集思路 延伸: 渗透测试中的技巧 后渗透阶段的攻防对抗 linux入侵后续指南 mimikittenz:又一款Windows密码获...

49160
来自专栏技术之路

翻译qmake文档(一) qmake指南和概述

英文文档连接: http://qt-project.org/doc/qt-5/qmake-manual.html http://qt-project.org/d...

27870
来自专栏逸鹏说道

★Kali信息收集~4.DNS系列

★.1host:DNS信息 参数: ? 一般情况下,host查找的是A,AAAA,和MX的记录 ? 案例: DNS服务器查询 host -t ns 域名 ? ...

33980
来自专栏DannyHoo的专栏

友盟推送使用别名(Alias)推送到具体用户

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/u010105969/article/details/...

54550
来自专栏生信技能树

Centos 下非 Root 安装 Microsoft R Open

Centos 下非 Root 安装 Microsoft R Open 作者: Hyacz hyacinth.hao@foxmail.com 2017年8月30...

527120
来自专栏difcareer的技术笔记

编译nexus5的linux kernel源码

ubuntu14.04编译android4.4对应的linux内核 中讲述了适用于模拟器的linux kernel源码编译。适用于真机的有一些不同。为了能够对比...

10220
来自专栏雪胖纸的玩蛇日常

django2+uwsgi+nginx上线部署到服务器Ubuntu16.04(最新最详细版)

37460
来自专栏程序员叨叨叨

听说你使用Android Studio遇到了一些小困惑

这个问题通常出现在Android Studio更新失败的时候,原因是download http://services.gradle.org/distributi...

11540

扫码关注云+社区

领取腾讯云代金券