SwaggerHub - 定義エディター

重要な API を定義する

» SwaggerHub: (主な機能に戻る)

どの製品でも定義段階が最も重要で時間がかかり、API は他の製品と変わりません。 すべての設計者は、アイデアを生かすうえで、適切なツールを持つことが非常に重要であると言います。 そのため SwaggerHub は、すばらしい定義ツールを構築することに多大な努力を払っており、登録ユーザーには無料でアクセスできるようにしています。

また、API 設計者、プロダクト マネージャー、アーキテクト、テクニカル ライターなどの編集ツールの一部として、コラボレーションに重点を置くのは、API 戦略を成功させるための重要な要素です。

編集

エディターから始めましょう。これは API 定義を作成し、SwaggerHub の最も重要なコンポーネントの 1 つです。編集機能は、多くの人が編集ツールとして採用しているオープンソースのツールである swagger-editor に基づいています。エディターを使用すると、YAML エディターで API 定義を作成して、ビジュアライザー パネルで実際に表示されることを確認できます。

作業中の API バージョンの swagger.info をすぐに変更する必要がある場合、[Version Info] タブを使用すると、作成している API 定義のバージョンに関する一般情報を更新できる簡単なフォーム エディターを表示します。

検証

おそらく、ユーザーからの最も一般的な要求の 1 つは、タイムリーかつ有用なエラー メッセージを提供することです。ビルド時に API 定義に注目し、定義が Swagger 仕様を満たすために必要な情報をすぐに提供します。

エラー メッセージを表示するだけでなく、エラーが発生した場所の正確な行へのリンクも表示されるので、その場所に素早くジャンプして修正することができます。

コラボレート

なぜ API を一人で設計するのですか?

SwaggerHub の最も魅力的な機能の 1 つは、素晴らしい API を定義するために API の天才的な友人と協力できることです。コラボレーション機能を使用して、他のユーザーを API 定義で作業するように招待します。 API を使って作業するユーザーを最大 25 人まで招待することができます。

共同作業者は、制限なしで API 定義を改訂することができ、開発チームは管理上のオーバーヘッドがなしで効率的に作業できます。

簡単に直感的に SwaggerHub を使用して、定義できる API が見つけられます。

 

ページ トップに戻る