SwaggerHubは、Swagger (OpenAPI) を使用した API 開発におけるチームの連携方法を変えるために作成されました。SwaggerHub は、オープンソースの Swagger ツールのコア機能を集約するだけでなく、既存の Swagger 定義をすべてホストおよび管理し、チーム全体で API の設計とドキュメント作成を共同で行うための中心的なプラットフォームを提供します。プラットフォームの立ち上げ以来、SwaggerHub ユーザーから最も多く寄せられた機能の 1 つは、異なる社内チーム間で作業中の API をより適切に整理する機能でした。これらのチームにとって、SwaggerHub は既存のすべての Swagger 定義をホストおよび検出するための中央リポジトリとなっています。これらの組織が API 開発を拡大し続けるにつれて、さまざまなチーム間で API 定義をより適切に整理する必要性がますます明確になりました。本日、SwaggerHub でチームの API を整理するより良い方法であるプロジェクトを発表できることを嬉しく思います。
プロジェクトの仕組み
今日まで、SwaggerHub 内で API を整理する最善の方法は組織でした。組織を使用すると、すべてのチームメンバーと共有 API を 1 つのアカウントの下にグループ化できます。組織の所有者は、チームメンバーを組織に簡単に招待でき、各共同作業者が API で作業できるアクセスレベルを管理できます。しかし、これまでの組織の欠点の 1 つは、各メンバーがすべての API 定義に完全にアクセスできるため、チームが作業している増え続ける API の数を管理するのが少し複雑になることでした。プロジェクトはその問題を解決します。組織の所有者は、組織の API またはドメイン (API 設計を標準化するために複数の API で使用できる再利用可能なコンポーネント) の選択した数を格納できるプロジェクトと呼ばれる特別なフォルダーを作成し、これらのプロジェクトを組織内の異なるメンバーまたはチームに割り当てることができます。
プロジェクトが Swagger ワークフローの改善にどのように役立つか
API チームがオープンソースの Swagger ツールや商用サードパーティの API 開発ツールから
SwaggerHub に切り替える最大の理由の 1 つは、組織内の異なるチームによって特定の時間に作業されているさまざまな API プロジェクトを追跡するのが難しくなりすぎることです。API 開発は非常に反復的であり、設計からデプロイまでにはソフトウェア開発チーム全体の利害関係者からの意見が必要です。プロジェクトは、Swagger ワークフローを整理し、Swagger で世界クラスの API を構築するのに役立つ人々をより適切に管理するためのまったく新しい方法を提供します。
SwaggerHub で最初のプロジェクトを設定する方法
プロジェクトを作成するには、組織の**所有者**である必要があります。以下の手順に従ってください。
1. 「新規作成」>「新規プロジェクトを作成」を選択します。
2. プロジェクトに名前を付けます。
次の画面で、プロジェクトが属する組織を指定し、プロジェクト名と任意の記述 (40 文字まで) を入力します。
3. API とドメインを選択します
プロジェクトを作成した後、API とドメインを追加できます。これは今すぐ行うことも、後で行うこともできます。API とドメインを追加するには、検索ボックス内をクリックし、ドロップダウンリストから API またはドメインを選択します。
API またはドメインをすばやく見つけるには、検索ボックスにその名前の一部を入力します。SwaggerHub はドロップダウンリストをリアルタイムでフィルタリングします。必要なだけ多くの API とドメインを追加できます。リストに API またはドメインが表示されない場合、その API またはドメインは組織が所有していない可能性が高いです。この場合、この手順をスキップし、後で API (またはドメイン) の所有権を組織に譲渡してから、API またはドメインをプロジェクトに追加できます。
4. メンバーを招待する
このステップでは、プロジェクトにユーザーを追加できます。これは今すぐ行うことも、後で行うこともできます。今すぐユーザーを招待するには、検索ボックス内をクリックし、ドロップダウンリストから目的のユーザーを選択します。
リストには、組織のメンバーのみが表示されることに注意してください。必要なユーザーがリストに表示されない場合は、まずそのユーザーを組織に追加する必要があります。
5. プロジェクト設定の確定
プロジェクトに API とドメインを追加し、ユーザーを招待したら、「メンバーを招待」ページで「保存」をクリックします。これにより、API およびユーザーリストに対する変更が保存されます。
SwaggerHub プロジェクトの完全なドキュメントはこちらで読むことができます。 プロジェクトで API 開発を整理し始める
プロジェクトは、多数の API を維持および反復する必要がある API チームのさまざまなユースケースに合わせて設計されています。特定の API プロジェクトを管理する必要がある異なる社内チームがある場合でも、
マイクロサービス アーキテクチャ内のサービスのすべての異なる Swagger 定義を整理するより良い方法が必要な場合でも、SwaggerHub が役立ちます。
今すぐログインして、SwaggerHub で最初のプロジェクトを開始してください。新機能についてのご意見をお聞かせください。電子メール
[email protected] を送信するか、SwaggerHub ダッシュボードの上部にあるチャットアイコンをクリックして、チームメンバーとチャットしてください。