web-dev-qa-db-ja.com

ODataエンドポイント(swagger、swashbuckle、その他)を文書化する方法は?

ODataエンドポイントを文書化する最良の方法は何ですか? Swashbuckleを使用する方法はありますか?

14
free4ride

はい、試してください Swashbuckle.OData 。 ODataControllersのSwashbuckleサポートを追加します。

ここで実際の動作を確認してください: http://swashbuckleodata.azurewebsites.net/swagger

8

はい、yaml-> Swagger、yaml-> csdlのようにサポートしようとしています。

ただし、実装には時間がかかります。プロトタイプを確認して追跡できます https://github.com/OData/model-first

4
Fan Ouyang

私は実際にSwashbuckle内のIDocumentFilter関数を使用してこれのために何かが機能するようになりました。 SwashbuckleのGitHubリポジトリで同様の質問に答えました。ここで私の応答をチェックしてください(それは下または下に向かっています):

https://github.com/domaindrivendev/Swashbuckle/issues/149

SwaggerUIでODataエンドポイントをセットアップするために活用できる実用的なIDocumentFilter実装の例を投稿しました。

4
Erik Dahl

AspNETおよびAspNET CoreApiバージョン管理

ApiExplorerWebApiの両方に Api Versioning (Odata情報でAspNetCoreを拡張するため)を使用できます。

両方に利用できるサンプルがあります。

この サンプル は、Swashbuckle/Swagger uiとうまく統合されます。

1
Fab

私が見つけた最も簡単な方法は、 https://github.com/oasis-tcs/odata-openapi を使用してOData定義をOpenAPI仕様に変換することです。

次に、スペックドキュメントをSwaggerにインポートするのは非常に簡単です。

1
Jérôme B