闊歩は、対話型のAPIドキュメントジェネレータのセットであるHTMLを使用してJavascriptが書かれた、以前にASP.NETのWeb APIのヘルプページで説明したとは異なり、闊歩は、オープンソースソフトウェアのセットで、今、RESTのAPIの多くをサポートしていますこれは、API仕様の出力を表示することに加えて、インタラクティブなドキュメントですが、また、ユーザが闊歩UIインターフェイス上でリアルタイムに動作することを可能にするという理由で、あなたはすぐに結果を見ることができます。
これが闊歩は、ASP.NETのWeb APIプロジェクトで機能する追加する方法の簡単な説明です。
濶歩
http://swagger.io/
かなり特徴と何かを何ができるか分からない場合闊歩は、私は、いくつかの機能動作し、知ることができるはずのポイントを参照してください見てすることをお勧めライブデモサイトの公式サイトに行くことができます
http://petstore.swagger.io/
ASP.NETのWeb APIプロジェクトでのインストール中
だから、どのようにASP.NETのWeb APIプロジェクトを使用するには?
実際には、あなたがゼロから一生懸命闊歩をインストールすることはできません、誰かがすでにだけでASP.NETのWeb APIプロジェクトにNuGetからインストール、良いNuGetキットを開発し、その後、わずかにそれを修正した、基本的なインストールはちょうど続く、非常に複雑ではありません次の手順は、それを作ります。
例としては、「ASP.NETウェブAPI - ヘルプページ」の前に続く、すなわち、2つのパッケージのインストールNuGetを通じてプロジェクトで、例の記事を:SwashbuckleとSwashbuckle.Core
インストールSwashbuckle Swashbuckle.Coreが来るに沿って、インストールされます。
SwashbuckleとSwashbuckle.Coreをインストールした後、次のファイルが存在し確立されていないかどうかを確認するために、
App_Start / SwaggerConfig.cs
一定要做的就是别忘了 Controller 与 Action 方法要加上 Summary
另外千万别忘了在项目属性里要勾选建置时输出“XML 文档文件”
再来最重要的就是修改 SwaggerConfig.cs 的内容,在程序的第 99 行,将这一行给反注解,
不过把这一行给反注解之后却会出现错误,
这是因为还没有实践 GetXmlCommentsPath() 方法,这个方法是要提供 XML Document 文件的路径,这么一来 Swagger 才能够正确的显示 Controller 与 Action 方法的相关资讯,
万事具备之后就可以执行网站了,要查看 API 服务的 Swagger 文档页面,在网址根目录后面加上 Swagger 就可看到,例如:http://localhost:60900/Swagger
线上执行后显示回传结果
这一篇只是做简单的介绍,如果你有兴趣可以在进阶研究 Swagger,但因为我们是开发 ASP.NET Web Api 并且是使用 Swagger for Web API - Swashbuckle,所以建议各位要进阶研究的对象应该是“Swashbuckle”,其实有很多很进阶的修改与设定可以玩的。
Postman 与 Swagger 的差异
- Postman 适合开发人员的统整管理,并且可以直接导出 C# (RestSharp) 的程序,并且直接放在程序里使用
- Swagger 适合即时开发的使用,甚至是提供给非开发人员测试使用
- 建议两种同时使用,开发人员在开发时的测试可以使用 Swagger 马上做测试,完成开发后可以到 Postman 之后去对系统做测试
参考连结
http://swagger.io/
http://petstore.swagger.io/
https://github.com/domaindrivendev/Swashbuckle
KingKong Bruce记事: ASP.NET Web API 文档产生器(2) - Swagger
以上
分享
原文:大专栏 ASP.NET Web API 文档产生器 - 使用 Swagger