私は Microsoft スタックに精通しています。一部の安らかなサービスに OData を使用しています。最近、API ドキュメントの Swagger に出会い、OData との関係を理解しようとしています。どちらもRESTful仕様のようです。広く使われているのはどれ？
質問する
23224 次
1 に答える
95
SwaggerはAPI を文書化するための仕様です。API 用の Swagger ドキュメントを作成することで、それを Swagger UI のインスタンスに渡すことができます。これにより、ドキュメントがきちんとした読みやすい形式でレンダリングされ、API を呼び出すためのツールが提供されます。詳細については、swagger.io Web サイトを参照してください。
ODataは、 http を介してデータ サービスを作成するための仕様であり、サービスを構築する方法と従うべきパターンを定義します。たとえば、$top ディレクティブを使用して、データ セットの最初の n 個の結果を提供します。OData は現在バージョン 4 ですが、v2 のドキュメントには非常に優れた概要があります。
Swashbuckleは、出力ドキュメントを形成するために提供するコードと追加のメタデータの検査に基づいて、API の swagger ドキュメントを自動的に生成するMicrosoft スタックの nuget パッケージです。
Swashbuckle で、作成中の OData API 用の swagger ドキュメントを自動的に生成する場合は、Swashbuckle.ODataを使用してこれを提供できます。
.NET Core を使用している場合は、もう少し複雑になりますが、完全な例は.NET Core Swagger OData サンプルにあります。
OpenAPIは、API を記述するための仕様です。Swagger は、OpenAPI標準の実装です。詳細については、こちらをご覧ください。
これが混乱を解消するのに役立つことを願っています。
于 2016-05-23T09:02:20.540 に答える