Swagger (OpenAPI) のバックアップ(No.1) - マイクロソフト系技術情報 Wiki

// Swashbuckle の構成
config.EnableSwagger(c =>
{
	c.SingleApiVersion("v1.0", "WebApplication");
	c.IncludeXmlComments(System.AppDomain.CurrentDomain.BaseDirectory + @"bin\WebApplication.XML");
})
.EnableSwaggerUi(c => { });

「/swagger/ui/index」にアクセスする。
すると、Swagger UI のドキュメントページが表示される。

↑

不明点 †

モデル・バインディングの仕様がカオスだから、自動生成だけでイケる気がしない。
XMLコメントの書き方などにルールなどはないのかなぁ？などと思った。

この辺か？

ModelBinder? caused complex type to display property-by-property
5.2.2 · Issue #536 · domaindrivendev/Swashbuckle
https://github.com/domaindrivendev/Swashbuckle/issues/536

c# - Swashbuckle and Web Api method with ModelBinder? - Stack Overflow
http://stackoverflow.com/questions/30429592/swashbuckle-and-web-api-method-with-modelbinder

ざっと見たところ、[FromBody?] や [FromUri?] などの属性で、
絞ることで、Web APIの仕様も明確になるものと思われる。

↑

Microsoft.AspNet?.WebApi?.HelpPage? †

https://www.nuget.org/packages/Microsoft.AspNet.WebApi.HelpPage

以下のドキュメント出力機能を持つ。

XML コメントが適用される
出力のカスタマイズが可能
実装コードと同期
APIテストが可能

ASP.NET MVCへの依存が欠点とされる。

IIS 以外の環境でホストできない（ASP.NET Web APIはセルフホストが可能）
.NET Coreに対応していない（.NETStandardの文字が見えない）。
ASP.NET MVCのレスポンスとしてしかドキュメントを確認できない。

↑

参考 †

Swagger を使った ASP.NET Web API のドキュメント生成 - miso_soup3 Blog
http://miso-soup3.hateblo.jp/entry/2014/12/17/233409

ROMANCE DAWN for the new world
- Swagger 2.0 に対応した ASP.NET Web API のドキュメントを作成する
  http://gooner.hateblo.jp/entry/2015/12/08/011159
- ASP.NET Web API の Swagger ドキュメントからパラメータのモデル名を削除する
  http://gooner.hateblo.jp/entry/2016/07/27/063717

ASP.NET Web API2.2で、Swagger(Swashbuckle 5.1.5)を使う - BEACHSIDE BLOG
http://beachside.hatenablog.com/entry/2015/05/31/202348

ASP.NET Core で作成した Web API のドキュメントを Swagger を使って生成する - Qiita
http://qiita.com/t-koyama/items/02571ac025cc54f0dbcb

Swashbuckle が生成する API 定義をカスタマイズする | Microsoft Docs
https://docs.microsoft.com/ja-jp/azure/app-service-api/app-service-api-dotnet-swashbuckle-customize

↓そんなのないから良かったのではないか？

RESTful APIの記述標準化を目指す「Open API Initiative」を
マイクロソフト、Google、IBMらが立ち上げ。Swaggerをベースに－ Publickey
http://www.publickey1.jp/blog/15/open_api_initiative.html

Tags: :.NET開発, :.NET Core, :ASP.NET, :ASP.NET Web API