SmartBear SwaggerHub : API の設計とドキュメント化のためのプラットフォーム :エクセルソフト


SwaggerHub - API 構築を共同で作業

チームが共同で API 開発を行うための最速な方法


API の定義、構築、管理に最適な場所 - Swagger を使った API の設計とドキュメント化のためのプラットフォーム

API はソフトウェア開発プロセスを左右しています。API は単なるコードではありません。ソフトウェアのミッション クリティカルで最上級の部分であり、他の製品とはバージョン管理、変更管理、および検出に関してる異なるニーズがあります。

SwaggerHub は API ライフサイクル全体に渡ってチーム全体に適切なツールを確実に提供することを目標としています。


API を定義する

柔軟な記述方法 - SwaggerHub のエディターで YAML を直接編集できます。SwaggerHub のドキュメント機能は、バリデーターのすべての機能を提供すると同時に、API をビルドする際に API を試す機能も提供します。

  • 基本的なメタデータを編集したい人には、単純なフォームベースの Info エディターがあります。
  • オンザフライ検証により、設計段階で迷子になりません。

チーム全体とのコラボレーション

すべての人にリアルタイムで可視性を提供する 1つの統合されたインターフェイス。チーム全体が連携して API 定義を定義、拡張、公開することを促進します。さらに、組織内または外部から共同作業者を簡単に招待できます。


コードの迅速な生成と API の構築

SwaggerHub のコード テンプレートは常に更新され、常に最新のテンプレートにアクセスできます。

  • バックエンド開発には、6つのビルトイン サーバー コード テンプレートのいずれかを使用できます。

Registry に直接公開する

DockerHub と GitHub のリンクを追加することで、API を検出して簡単に使用できるようにします。または、Registry API を使用して、使用するツール内から簡単に公開することができます。 Registry に API を公開するだけで、企業や組織全体で Wiki ページ、リンク、API 定義への参照が不要になります。


統合を管理

複数の統合を追加および管理して API の機能を拡張し、SwaggerHub の既存のツールセットに簡単に接続して API ライフサイクルをさらに推進します。

  • GitHub Sync のような統合により、生成されたコードを GitHub リポジトリと迅速に同期させることができます。
  • DockerHub へのリンクを追加して API を簡単に使用できるようにして、ユーザーが対応するコンテナを簡単に見つけてダウンロードできるようにします。
  • Swagger 定義を Webhooks 統合で定義したサービスに簡単にプッシュできます。

 

ページ トップに戻る

SwaggerHub - コラボレーションとビルド

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

SwaggerHub を使用すると、API ライフサイクル全体を手軽に利用できます。

  • コラボレーティブなデザイン。
  • インタラクティブなドキュメント。
  • Swagger ベースの API を簡単に検索できるレジストリです。

その中心となる SwaggerHub は、オープンで統合された技術の Swagger 原則に基づいています。

  • API バージョンを保護するために GitHub と統合します。
  • DockerHub にリンクすると、API のコンシューマーは簡単に API をダウンロードして使用できます。
  • SwaggerHub Registry API を使用して、API ディレクトリと統合します。

定義エディター

直感的なエディターを使用して API 定義を作成し、API 定義で他のユーザーと共同作業します。オンザフライ検証により公正さを保ちます。

詳細はこちら...

 

コード生成

クライアントとサーバーのコード テンプレートを使用して、開発プロジェクトを迅速に開始できます。

詳細はこちら...

 

バージョン管理

さまざまなバージョンの API 定義を管理し、いつバージョンを公開するのか、GitHub にプッシュするのかを決めます。

詳細はこちら...

 

API レジストリ

Swagger ベースの API のリストを参照して、インタラクティブなドキュメントを使用してそれらを探索できます。

詳細はこちら...

 

ドメイン

複数の API 定義にまたがって使用できる再利用可能なコンポーネントをすべて保存して、時間を節約して生産性を最大にします。

詳細はこちら...

 

プラグイン

 

ページ トップに戻る

SwaggerHub - 評価版リクエスト

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

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

 

ページ トップに戻る