web-dev-qa-db-ja.com

Swaggerとは何ですか?ODataに関連していますか?

Microsoftスタックに精通しています。安らかなサービスのいくつかにODataを使用しています。最近、APIドキュメントのSwaggerに出会い、ODataとの関係を理解し​​ようとしています。どちらもRESTful仕様のようです。どれが広く使用されていますか?

32
Muthukumar

Swaggerドキュメント作成APIの仕様です。 APIのSwaggerドキュメントを作成することにより、Swagger UIのインスタンスにドキュメントを渡すことができます。これにより、ドキュメントが見やすく読みやすい形式でレンダリングされ、APIを呼び出すためのツールが提供されます。詳細については、 swagger.io Webサイトを参照してください。

ODataは、httpを介したデータサービスを作成するための仕様であり、サービスの構築方法および従うパターンを定義します。たとえば、$ topディレクティブを使用して、データセットの最初のn個の結果を提供します。 ODataは現在バージョン4ですが、v2のドキュメントには 非常に良い概要 があります。

Swashbuckleはヌゲットパッケージです Microsoftスタックの場合APIのスワッガードキュメントを自動的に生成する出力ドキュメントを整形します。

Swashbuckleで構築中のOData APIのSwaggerドキュメントを自動的に生成する場合は、Swashbuckle.ODataを使用して提供できます。

OpenAPIは、APIを記述するための仕様です。 Swaggerは、OpenAPI標準の実装です。詳細を見つけることができます こちら

これが混乱を解消するのに役立つことを願っています。

58
Murray Foxcroft