SwaggerHub - API 構築を共同で作業

チームが共同で API 開発を行うための最速な方法 - API 開発用の唯一信頼できる情報源


より高速な標準化されたAPI設計の実現

高品質の API が実現するだけではありません。 それらは、ビジネス ゴールに合わせた一貫した設計標準から始まります。 SwaggerHub を使用すると、品質とスタイルの一貫性を確保しながら、チームの設計プロセスを加速できます。 API エディターは、Swagger (現在 OpenAPI 仕様 (OAS) と呼ばれる) に準拠しており、シンプルで直感的です。

チームの API 設計ワークフローを次の方法でアップグレードします。

  • エディター内でのスマートなエラー フィードバックと構文の自動補完
  • 設計中に API モックを自動的に作成する機能
  • リアルタイムで標準を強化する組み込み API 設計ルール
  • API 全体で共通の OAS 構文を分類および再利用するためのドメイン


コラボレーションして、よりスマートに

コミュニケーションの欠如ほど、開発サイクルを遅くするものはありません。 SwaggerHub は、複数のチームにわたる API コラボレーションと標準化を促進するように設計されました。 SwaggerHub を API 定義の唯一の信頼できる情報源として活用することで、高品質の API をより迅速に市場に提供できます。

以下のコラボレーションを明確にします。

  • 組織とチーム管理により、誰が何を所有しているかがわかります
  • 既存の API をフォーク、比較、またはマージできるようにする
  • エディターに隣接するリアルタイムのコメントと課題の追跡
  • API 定義をソース管理リポジトリおよびゲートウェイと同期する


ホストされたインタラクティブな API ドキュメント

API イニシアチブを成功させるには、正確で最新のドキュメントが不可欠です。 SwaggerHub を使用すると、設計中にインタラクティブなドキュメントを自動的に生成できるため、API コンシューマーと内部ユーザーの両方が API を簡単に学習して操作できます。

次の方法で API ドキュメントへのアプローチを強化します。

  • 開発を通知するための API 動作の青写真を提供する
  • 1 つの中央プラットフォームでの OAS 定義のインポートとホスティング
  • 組み込みの権限とユーザー役割による API ドキュメントへのアクセスの管理
  • 一貫性を確保するための OAS ドキュメントのバージョニングと公開


マイクロサービスへの移行の管理

RealPage のチームがどのように SwaggerHub Enterprise を使用して、配信までの時間を短縮し、チーム間で共通の方法でコミュニケーションするかをご覧ください。


SwaggerHub for Teams

API ワークフローを合理化し、素晴らしい API をこれまでよりも速く提供したいチーム向け。

  • インタラクティブ エディター
  • ファイルを共同編集
  • ホストされているドキュメント
  • 自動モッキングの設計

詳細は、こちら

SwaggerHub Enterprise

オンプレミスまたはクラウドで利用可能な安全な環境で複数のチームにわたって作業する必要がある組織向け。

  • API 標準化
  • 再利用可能なドメイン
  • チームとプロジェクト
  • オンプレミス インストール

詳細は、こちら


 

ページ トップに戻る

SwaggerHub - API 開発を迅速かつ簡単に

SwaggerHub は、API 開発ワークフロー全体で一貫性と規律を推進するためにチーム向けに構築された、統合された API 設計およびドキュメンテーション プラットフォームです。

SwaggerHub は、チームの API 設計ワークフローをサポートする機能を提供します。


スピードと効率性のために構築された強力な API エディターで API を設計します。

最新の Swagger (OpenAPI) 標準に完全に準拠した強力なエディターにより、品質や組織スタイルの一貫性を損なうことなくチームの設計プロセスを加速します。

  • スマートなエラーフィードバックと構文のオートコンプリートを備えた強力なエディター
  • コードなしで操作を仮想化する API モッキング
  • 複数の API 間で設計の一貫性を確保するためのスタイル バリデーター
  • 複数の API で共通の OAS 構文を保存、再利用、参照するためのドメイン

 

OAS 設計用の強力なエディター

Swagger/OpenAPI コントラクトの迅速な反復のために構築された直感的なブラウザーベースのエディターで、新規および既存の API を設計します。 コンシューマーの採用を最大化する API を設計するための手間のかからない編集エクスペリエンスにより、その場で設計を検証して保存します。

 

スタイルのガイドラインを設定して適用

組み込みの API 標準化を使用して、すべての API が組織の設計標準に準拠していることを保証します。 API 全体でスタイルの一貫性を維持するために開発者が参照する必要がある wiki ページ、GitHub ドキュメント、PDF はもう必要ありません。

 

再利用可能なコンポーネントによる API 設計の高速化

API を定義するときに、すべての繰り返しパスと応答を継続的に書き換える必要をなくします。 SwaggerHub では、組織の一般的なスタイルを再利用可能なコンポーネントとして保存し、すべての API で再利用できます。

 

制御されたアクセスと開発者に優しいワークフローにより、API を一元的に維持およびコラボレーション

API の設計と開発を 1 か所に集中化して、チームが新しい API でシームレスに共同作業したり、集中化したプラットフォームで既存の API を発見したりできるようにします。

  • API で効果的にコラボレーションするための組織およびチーム管理
  • リアルタイムのコメントにより、共同編集者とコミュニケーションし、未解決の問題を追跡
  • フォーク、比較、マージにより、コラボレーション ワークフローを厳密に制御
  • ソース管理や API ゲートウェイなどの API ライフサイクル ソリューションとのシームレスな統合

 

より良い共同作業をする

SwaggerHub は組織向けに構築されており、API 契約、ドキュメント、チームを一元管理できます。 セキュリティやスケーリングを心配することなく、API の設計と構築に協力するチームを設定します。

 

コミュニケーションと問題の追跡

SwaggerHub コメントを使用して、新しいアイデアについて慎重に検討し、問題をハイライトし、それらを一緒に解決します。 SwaggerHub のコメントは発券システムとしても機能します。つまり、未解決の問題や会話を常に追跡し、それに応じて解決して優先順位を付けることができます。

 

API ワークフローを標準化する

複数の開発プラットフォームにまたがるさまざまなチーム メンバーからの更新を追跡するという頭痛の種を取り除きます。 開発者に必要な独立性を与え、設計者は変更を追跡し、更新が行われたときに通知を受けるために必要な監視を行います。

API ライフサイクルに統合する

GitHub、GitLab、Bitbucket などのソース管理ホスト間でのシームレスな同期から、AWS、Azure、IBM などの APIM プラットフォームへの API デプロイメント、カスタム Webhook を使用した外部ビルド トリガーまで、SwaggerHub は組織が API 開発を次のレベルに引き上げるように設計されています。

API をホストし、優れた API を提供するためにチームが信頼するツールに統合するための内部リポジトリー

クラウドでホストされている中央の内部リポジトリから API ライフサイクル全体を調整します。

  • API 定義をホストおよびアクセスするための中央リポジトリ
  • 継続的なメンテナンスと継続的な反復のための API バージョン管理
  • 更新と API の変更を追跡する自動通知
  • 簡単なデプロイのための安全な統合

 

API の定義をホスト

SwaggerHub は、API 定義をホストおよび発見するための真の情報源として機能します。 内部リポジトリで API 定義をホストし、チーム、プロジェクト、またはその他のアーキテクチャ上の考慮事項に基づいて API を整理します。

 

API バージョンの管理

RESTful サービスへの変更は不可避であり、既存の API のバージョン管理を容易にすることは、エラーが発生しやすいプロセスになる可能性があります。 SwaggerHub を使用すると、API の新しいバージョンを継続的に更新および公開できるため、ユーザーは適切なバージョンに適切なタイミングでアクセスできます。

 

監視とガバナンスの改善

API が進化して変更が加えられると、利害関係者の調整を保つことが重要です。 SwaggerHub は、API アーキテクトとチームに、変更の追跡、問題の解決、API の内部開発方法の標準化に必要な監視を提供します。

API ライフサイクルに統合する

設計とドキュメントは、より大きな API ライフサイクルの一部にすぎません。SwaggerHub はそれらに特化していますが、チームが他の外部ソフトウェア ソリューションとシームレスに連携できるようにします。 API ゲートウェイにデプロイする場合でも、サーバー側のコードリポジトリと同期する場合でも、テストツールに接続する場合でも、SwaggerHubは 既存のワークフローにうまく適合します。

 

安全にホストされ、完全にインタラクティブな API ドキュメントを自動的に生成

インタラクティブで完全にホストされ、プライバシーが有効な美しいドキュメントを生成し、手動のインフラストラクチャの複雑さを完全に排除します。

  • Swagger UI ドキュメントの自動生成
  • OAS 定義をインポートしてホストし、文書化プロセスを続行
  • 組み込みの権限とユーザー役割で API ドキュメントへのアクセスを管理
  • 複数の API ドキュメント バージョンを維持および更新するためのバージョン管理

 

プロ仕様のドキュメント

SwaggerHub は、実際の API コントラクトを視覚的にレンダリングし、ライブ ワークアビリティの完全なインタラクティブ ドキュメントとして提供します。これにより、エンド コンシューマーは、コードに統合する前に、API がどのように動作し、動作するかを正確に知ることができます。

 

OAS ドキュメントの自動生成

SwaggerHub で OAS を使用して API の文書化をすぐに始めたいですか? 統合された Swagger Inspector を利用すると、既存の API から OAS ドキュメントを生成できます。 3 ステップ以下で、OAS 定義が生成され、SwaggerHub でホストされます。

 

API ドキュメントのインポートとホスト

API の既存の OAS 定義がありますか? Web またはローカル ファイル システムから追加のドキュメントを取得するために、既存の OAS ベースの API をインポートできます。 API 定義とそのドキュメントは、インポート時にクラウドに完全にインポートされるため、チームは API にリッチコンテンツとリソースを追加できます。

安全な環境でアクセスを管理する

API ドキュメントは、API コンシューマーがドキュメントにアクセスし、API の操作に必要な情報を取得できる場合にのみ役立ちます。 SwaggerHub を使用すると、API ドキュメントをクラウドでホストし、組み込みの権限制御と API ゲートウェイとの統合を通じて安全にアクセスを提供できます。

 

ページ トップに戻る

SwaggerHub Enterprise 版

デザイン / ドキュメント / ディスカバー

SwaggerHub Enterprise プランは、Swagger を使用したコラボレーティブ API 開発を拡張したいビジネス向けに構築されています。 SwaggerHub Enterprise は、クラウドとオンプレミスの両方のインストールで使用できます。

 

SwaggerHub Enterprise の機能

ファイアウォールの背後にオンプレミスをインストール
制限なしの API 設計のスケーリング
API スタイルのガイドラインを適用する
シングル サインオン (SSO) のサポート
オンプレミス ソリューションとの統合
チーム管理とガバナンスを改善

 

API 開発を拡張する

すべての API を 1 つの集中型プラットフォームで安全にホストし、すべてのチームと組織のメンバーが作業できるようにします。 組織のニーズに基づいて適切な人と API に適切なアクセスとプライバシーを提供し、複数のステークホルダー(利害関係者) とコンシューマーにわたって何百もの API を効果的に管理します。


ビジネス全体で API 設計を標準化

組織の API 全体で設計の一貫性を確保することは、API チームにとって頭痛の種になる可能性があります。 SwaggerHub Enterprise を使用すると、速度と開発時間を失うことなく、設計の一貫性を維持できます。 組織の一般的なスタイルとモデルをドメインに保存して、何百もの API プロジェクトで参照したり、Style Validator を使用して個々の API のスタイルの整合性をチェックしたりできます。


エンタープライズ SSO を使用したオンプレミスのインストール

SwaggerHub は、ファイアウォールの背後に SwaggerHub をインストールする機能を提供し、追加のカスタマイズと内部ツールとの統合を備えています。 SwaggerHub On-Premise を使用すると、セキュアなオンプレミス インストール、SAML を使用した SSO、LDAP および GitHub Enterprise、およびカスタマイズされた統合により、エンタープライズ プランのすべてのサポートを利用できます。


優先サポートとオンボーディング

オンボーディングとセットアップのプロセス全体を支援する専任のアカウントマネージャーがいます。 パーソナライズされたトレーニングをスケジュールし、必要なときに質問の回答が得られます。


 

SwaggerHub の評価版を取得するには、以下のボタンをクリックして、手続きを行ってください。

 

SwaggerHub の評価版は、14日間有効です。

 

ページ トップに戻る

SwaggerHub 統合

 

Swagger Inspector で OAS 定義を生成する

Swagger Inspector は、既存の API の OAS 定義を生成する最も速くて簡単な方法です。 数回クリックするだけで、OpenAPI 定義を生成し、それを SwaggerHub でホストできます。


API ゲートウェイにデプロイする

チームが API のデプロイと管理に使用するゲートウェイに SwaggerHub を接続し、SwaggerHub で API 設計を進化させ続けます。 統合により、API 設計とドキュメント間での展開と管理へのシームレスな移行が可能になります。 AWS、Microsoft Azure、IBM API Connect、Apigee などの主要な API 管理プラットフォームから選択できます。


ソース管理ホストと同期

SwaggerHub を利用してサーバー テンプレートとクライアント SDK を生成している場合は、API 定義をGitHub、Bitbucket、GitLab、Azure DevOps Services、Azure DevOps Server のソース管理リポジトリと同期することもできます。 同期は、SwaggerHub で API を保存するたびに行われます。 ターゲット リポジトリで追加、更新、または無視するファイルを完全に制御できます。


機能テストを生成する

API 定義は、QA チームが API の機能をテストするためのテストケースを簡単に生成するためのコントラクトを提供します。 SmartBear の機能テストプラットフォームである SoapUI のユーザーは、API 定義をインポートして、機能テストをすばやく生成して実行できます。


Webhook でカスタムアクションをトリガー

Webhook を使用すると、ライフサイクル中に独自のサービスと統合をトリガーできます。 ビルドのトリガー、ユニット テスト、開発者へのメール送信のいずれであっても、SwaggerHub Webhook を使用して自動化シナリオを思い描くことができます。


 

SwaggerHub の評価版を取得するには、以下のボタンをクリックして、手続きを行ってください。

 

SwaggerHub の評価版は、14日間有効です。

 

ページ トップに戻る

SwaggerHub - 製品価格

デザイン / ドキュメント / ディスカバー

 

SwaggerHub の価格は、こちらから

 


高度な機能を追加した SwaggerHub

大規模あるいは小規模なソフトウェアチームの進化するニーズに対応するために SwaggerHub は作成され、安全で統合されたプラットフォームを提供します:

  • Swagger 定義の作成、ホスト、およびバージョン管理
  • Swagger (OpenAPI) 仕様の新しい API と既存の API をドキュメント化
  • 選択した言語ですばやくコードを生成し、ソース管理リポジトリにプッシュ
  • API 定義にアクセスできるユーザーを制御しながら、チーム間で API を安全に作業
  • シームレスな API Gateway 統合を使用して、構築からデプロイまでの時間を短縮

 

オープンソースの Swagger と SwaggerHub の比較

オープンソースの 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 から参照して、作業を標準化して時間と労力を節約できます。

 

ページ トップに戻る

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 でも機械翻訳でご覧いただけます。

機械翻訳された日本語ドキュメント

 

ページ トップに戻る