これは私の理解です:
この情報は正しいですか?Swagger、Swashbuckle、Swashbuckle UIの意味を簡単に説明できない場合は、
また、これを使用しない場合、API開発者として何を失うのですか?
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]
コメントを追加