Swagger、Swashbuckle、Swashbuckle UIとは

青い雲:

これは私の理解です:

  • Swaggerは、ドキュメントを書くための表記法/ルールです。しかし、なぜそれが(Angular / MVCのような)フレームワークと呼ばれるのですか?
  • Swashbuckleは、ドキュメント(Swaggerルールに基づく)を生成するプログラム(JavaScript?)です。
  • Swagger UIにドキュメントが表示されます。これは、スワッシュバックルを使用して行われます。

この情報は正しいですか?Swagger、Swashbuckle、Swashbuckle UIの意味を簡単に説明できない場合は、

また、これを使用しない場合、API開発者として何を失うのですか?

James B. Nall:

Swaggerは、ドキュメントを書くための表記法/ルールです。しかし、なぜそれがフレームワークと呼ばれるのですか(Angle / MVCのように)?

OpenAPI仕様の下でRESTfulサービスのインターフェースに体系的な方法で通知することを目的としているため、おそらく「フレームワーク」と呼ばれます。仕様は評判の良いLinux FoundationのOpen API Initiativeによって監視されているため、これは開発者にとって大きな問題です。

Swashbuckleは、ドキュメント(Swaggerルールに基づく)を生成するプログラム(javascript?)です。

Swashbuckleは、.NET Web APIプロジェクトで利用できるパッケージ(またはライブラリ)です。これは、あなたが正しく示したように、プロジェクトのSwagger仕様を生成することを目的としています。さらに、Swagger UIはSwashbuckle内に含まれているため、.NETでAPIを開発している場合は、パッケージのワンストップショップとして最適です。JavaScriptではなく、ほぼ完全にC#で記述されています。

Swagger UIにドキュメントが表示されます。これは、スワッシュバックルを使用して行われます。

はい、Swagger仕様は人間に優しい方法で表示されます。ただし、スワッシュバックルはこれに必要なコンポーネントではありません。彼らは、先ほど言ったことを除いて、完全に相互に排他的です。

また、これを使用しない場合、API開発者として何を失うことになりますか。

これは今、意見の領域に入っていますが、私はそれについて客観的になるように努めます。私はSwashbuckleを使用して、アプリケーションAPIのクライアントの作成を支援しています。(それほど多くはありませんでした)実装学習曲線を通過した後、このパッケージは私がクライアントを自分で書く時間をかなり節約しました。小規模なアプリケーションの場合、Webクライアントの作成は簡単ですが、エンタープライズレベルのアプリケーションは複雑さを増し続けたり、変化したりする傾向があるため、これらのクライアントの作成/更新を完全に自動化すると便利です。

つまり、それを使用しない場合は、APIクライアント生成の代替方法を使用するか、クライアントを自分で作成/更新する必要があります。バックエンドのみを開発している場合、これは完全に無意味な場合がありますが、APIサービスを使用するクライアントアプリの作成を担当する人を助けるのは確かです。

これらの回答がお役に立てば幸いです。乾杯!

この記事はインターネットから収集されたものであり、転載の際にはソースを示してください。

侵害の場合は、連絡してください[email protected]

編集
0

コメントを追加

0

関連記事

分類Dev

Swagger、Swashbuckle、Swashbuckle UIとは

分類Dev

How do I get Swashbuckle to have Swagger UI to group by Version?

分類Dev

Swagger Ui(SwashBuckle for Core) is not throwing UI level Error Message for Mandatory Headers

分類Dev

Swagger / SwashbuckleにAPIキーを追加させる方法は?

分類Dev

Swashbuckle SwaggerResponseRemoveDefaults属性は、Swaggerに200の成功応答を追加します

分類Dev

Swashbuckle / SwaggerをMono(.NET)Frameworkで動作させる方法は?

分類Dev

Swashbuckle Swagger-コンテンツタイプに注釈を付ける方法は?

分類Dev

Swashbuckle、Swagger Pattern andFormatアノテーションまたはXMLコメント

分類Dev

Swagger UIでSwashbuckleでポート443を使用するにはどうすればよいですか?

分類Dev

Swashbuckle Swagger UI:xmlコメントのパラメーターから必須を削除する方法

分類Dev

Swashbuckleを使用してBlazorプロジェクトc#からSwagger UIを生成できますか?

分類Dev

Swashbuckle.AspNetCore.Swagger への参照を追加すると、赤い波線が表示されます。

分類Dev

Swashbuckle Swagger:モデルの配列パラメーターのタイプを表示する方法は?

分類Dev

Swagger-Swashbuckleには、依存するdllからのxmlcommentsが含まれています

分類Dev

Swashbuckleで生成されたSwaggerは、Azure APIManagementで重複するバージョンパスを作成します

分類Dev

Swashbuckleを使用する場合は、グローバルアイテムをswagger.jsonに追加します

分類Dev

Swagger + Swashbuckleでエンドポイントを表示するにはどうすればよいですか?

分類Dev

Location of swagger.json when created with Swashbuckle

分類Dev

Add summary or vendorextensions to Paths in swagger using swashbuckle

分類Dev

Swagger Ui(SwashBuckle for Core)は、必須ヘッダーのUIレベルのエラーメッセージをスローしません

分類Dev

swashbuckleから自動生成されたswagger.jsonは、swaggerエディターで有効である必要がありますか?

分類Dev

Swagger Swashbuckleのバージョン4.0では、Swaggerページの上部に新しい大きな白いバーが導入されています

分類Dev

Swagger(C#の場合はSwashbuckle)は、MongoObjectIdを単一の文字列ではなく複数のフィールドとして表示します

分類Dev

IDocumentFilter、swashbuckle asp net core、swagger内のメソッドとコントローラーからすべてのCustomAttributesを取得します

分類Dev

承認を使用するようにSwashBuckle.AspNetCore.Swaggerを設定するにはどうすればよいですか?

分類Dev

ASP.NET Core Swagger(Swashbuckle.AspNetCore)でコントローラーの説明を定義するにはどうすればよいですか?

分類Dev

Swashbuckleに日付付き(時間なし)のSwaggerプロパティを生成させるにはどうすればよいですか?

分類Dev

C#Swashbuckle:廃止されたモデルプロパティはSwaggerを変更せずに表示されます

分類Dev

Swashbuckleのバージョン管理では、Swaggerに表示するデフォルトのAPIバージョンを選択します

Related 関連記事

  1. 1

    Swagger、Swashbuckle、Swashbuckle UIとは

  2. 2

    How do I get Swashbuckle to have Swagger UI to group by Version?

  3. 3

    Swagger Ui(SwashBuckle for Core) is not throwing UI level Error Message for Mandatory Headers

  4. 4

    Swagger / SwashbuckleにAPIキーを追加させる方法は?

  5. 5

    Swashbuckle SwaggerResponseRemoveDefaults属性は、Swaggerに200の成功応答を追加します

  6. 6

    Swashbuckle / SwaggerをMono(.NET)Frameworkで動作させる方法は?

  7. 7

    Swashbuckle Swagger-コンテンツタイプに注釈を付ける方法は?

  8. 8

    Swashbuckle、Swagger Pattern andFormatアノテーションまたはXMLコメント

  9. 9

    Swagger UIでSwashbuckleでポート443を使用するにはどうすればよいですか?

  10. 10

    Swashbuckle Swagger UI:xmlコメントのパラメーターから必須を削除する方法

  11. 11

    Swashbuckleを使用してBlazorプロジェクトc#からSwagger UIを生成できますか?

  12. 12

    Swashbuckle.AspNetCore.Swagger への参照を追加すると、赤い波線が表示されます。

  13. 13

    Swashbuckle Swagger:モデルの配列パラメーターのタイプを表示する方法は?

  14. 14

    Swagger-Swashbuckleには、依存するdllからのxmlcommentsが含まれています

  15. 15

    Swashbuckleで生成されたSwaggerは、Azure APIManagementで重複するバージョンパスを作成します

  16. 16

    Swashbuckleを使用する場合は、グローバルアイテムをswagger.jsonに追加します

  17. 17

    Swagger + Swashbuckleでエンドポイントを表示するにはどうすればよいですか?

  18. 18

    Location of swagger.json when created with Swashbuckle

  19. 19

    Add summary or vendorextensions to Paths in swagger using swashbuckle

  20. 20

    Swagger Ui(SwashBuckle for Core)は、必須ヘッダーのUIレベルのエラーメッセージをスローしません

  21. 21

    swashbuckleから自動生成されたswagger.jsonは、swaggerエディターで有効である必要がありますか?

  22. 22

    Swagger Swashbuckleのバージョン4.0では、Swaggerページの上部に新しい大きな白いバーが導入されています

  23. 23

    Swagger(C#の場合はSwashbuckle)は、MongoObjectIdを単一の文字列ではなく複数のフィールドとして表示します

  24. 24

    IDocumentFilter、swashbuckle asp net core、swagger内のメソッドとコントローラーからすべてのCustomAttributesを取得します

  25. 25

    承認を使用するようにSwashBuckle.AspNetCore.Swaggerを設定するにはどうすればよいですか?

  26. 26

    ASP.NET Core Swagger(Swashbuckle.AspNetCore)でコントローラーの説明を定義するにはどうすればよいですか?

  27. 27

    Swashbuckleに日付付き(時間なし)のSwaggerプロパティを生成させるにはどうすればよいですか?

  28. 28

    C#Swashbuckle:廃止されたモデルプロパティはSwaggerを変更せずに表示されます

  29. 29

    Swashbuckleのバージョン管理では、Swaggerに表示するデフォルトのAPIバージョンを選択します

ホットタグ

アーカイブ