SwaggerHub のリソース情報
SwaggerHub FAQ
SwaggerHub に関する 「FAQ - よくある質問とその回答」ページをご用意しております。
その他のリソース
■ SwaggerHub ドキュメント: https://app.swaggerhub.com/help/index
■ SwaggerHub オンプレミス リリースノート: https://app.swaggerhub.com/help/enterprise/release-notes
■ SwaggerHub Saas - 変更履歴: https://app.swaggerhub.com/changelog
■ SwaggerHub アカウントの作成方法: https://app.swaggerhub.com/help/signup
■ アカウント管理: https://app.swaggerhub.com/help/account/index
■ SwaggerHub チュートリアル: https://app.swaggerhub.com/help/tutorials/index
注意: 上記のオンライン ドキュメントは英語での提供となります。
※ Google Chrome で開き、Google 翻訳を選択するか、ページを右クリックし、コンテキストメニューの「日本語に翻訳(T)」 機能をご使用いただくと、機械翻訳された内容でご覧いただけます。 Microsoft Edge で開いて、Translator For Microsoft Edge でも機械翻訳でご覧いただけます。
機械翻訳された日本語ドキュメント
オープンソースの Swagger と SwaggerHub の比較
高度な機能を追加した SwaggerHub は、大規模あるいは小規模なソフトウェアチームの進化するニーズに対応するために作成され、安全で統合されたプラットフォームを提供します。
- Swagger 定義の作成、ホスト、およびバージョン管理
- Swagger (OpenAPI) 仕様の新しい API と既存の API をドキュメント化
- 選択した言語ですばやくコードを生成し、ソース管理リポジトリにプッシュ
- API 定義にアクセスできるユーザーを制御しながら、チーム間で API を安全に作業
- シームレスな API Gateway 統合を使用して、構築からデプロイまでの時間を短縮
| オープンソースの Swagger | SmartBear SwaggerHub |
|
|---|---|---|
| 設計 | 基本的なスタイルのバリデーションを行う YAML エディター | API 定義のためにあらかじめデザインされたテンプレート、同時のスタイル フィードバック、モック、ホスティングを備えたクラウドベースの YAML エディター |
| 開発 | Swagger CodeGen によるコード生成 | GitHub、Bitbucket、GitLab などのソース管理ホストと自動的に同期できる 20以上のサーバー言語でのコード生成 |
| ドキュメント | インタラクティブな API ドキュメントと SwaggerUI を使用したサンドボックス | インタラクティブな API ドキュメントとサンドボックス、およびクライアント SDK 用の自動生成、すべてがプライバシー制御でクラウドでホストされています。 |
| モック | モック機能はありません | コードを書くことなく操作を仮想化するための API のモックを生成 |
| ホスト | ホスティング機能はありません | Swagger 定義と API ドキュメントのための、アクセス制御機能を内蔵した安全なクラウドベースのホスティング |
| コラボレート | コラボレーション機能はありません | リアルタイムの問題追跡と会話、チーム管理、役割の割り当て、およびアクセス許可/アクセス制御 |
| デプロイ | デプロイメント機能はありません | AWS、Microsoft Azure、IBM API Connect などの API ゲートウェイに API 定義をすばやくデプロイできます。 サーバーレス デプロイ用のAWS Lambda 関数を自動的に生成します。 |
| バージョン管理 | バージョン管理機能はありません | API 定義の複数のバージョンを管理し、古くなった API を廃止 |
SwaggerHub が必要な理由
◎ 高度な設計機能を備えたクラウドベースのエディター
スタイルの検証を組み込んだクラウドベースのエディターで Swagger 定義を作成して編集して、エラーを減らしたり、API をどのように動作させるかをプレビューしたり、コードを書くことなく設計上の意思決定を検証することができる自動モック機能を利用できます。
◎ 統合ドキュメント ワークフロー
Swagger 定義を記述し、ドキュメントを操作し、他のツールを必要とせずに、直感的なインターフェイスでコードとクライアント SDK を生成します。 SwaggerHub はすべてを同期し、ソース管理と API 管理プラットフォームとシームレスに統合します。
◎ セキュアなクラウドホスティング
すべての API 定義と関連ドキュメントを API 用に構築されたプラットフォームに格納します。 SwaggerHub は設計プロセス全体を通して作業を自動保存し、サーバーを設定することなくドキュメントをホストする中心的な場所を提供します。
◎ プライバシーとアクセス コントロール
SwaggerHub のビルトインのプライバシーコントロールを使用して、API にアクセスできるユーザーを制御し、機密情報を保護します。 新しい API を設計する場合や、既存の Swagger 定義をドキュメント化する場合は、アクセス コントロールを使用してください。
◎ バージョン管理とパブリッシング
SwaggerHub は、API の複数のバージョンを管理する機能を備え、継続的に更新と反復処理を行います。 新しいバージョンでは、最後の更新されたバージョンから既存の構文をコピーするので、最初からビルドを開始する必要はありません。
◎ コラボレーション ＆ チーム管理
SwaggerHub は、チームが API の設計とドキュメント全体で協力するための中心的なプラットフォームを提供します。 SwaggerHub エディターのコメントで、API を社内外の投稿者と安全に共有し、問題をリアルタイムで追跡します。 SwaggerHub は、定義が変更されたときに自動的に共同編集者に通知します。
◎ ソース管理と API 管理プラットフォームとの同期
中心的なプラットフォームから API のライフサイクル全体を管理します。API のさまざまなバージョンをソース管理ツールや API 管理プラットフォームと同期させることで、Swagger 定義を更新し、ドキュメント、サーバーコード、およびデプロイメントを自動的に更新できます。
◎ 共通モデルの再利用
すべての共通コンポーネントをドメインに保存します。これをすべての API から参照して、作業を標準化して時間と労力を節約できます。
