APIオンラインドキュメント

APIドキュメントは、プロジェクトメンバーが共同作業、テスト、または参照用のユーザーを提供するのに役立つためによく使用されます。ツールを使用してAPIドキュメントを適切に共有する方法は良い選択です。Swagger、SosoAPI、Eolinker、Showdocなど、多くのオンラインAPIドキュメントツールがあります。現在、Eolinkerが仕事で使用されています。Eolinkerでは、プロジェクトをチーム外の人とオンラインで共有できます。また、他の人はAPIドキュメントをオンラインで表示し、共有リンクを介してAPIテストを実行できます。この方法でAPIドキュメントを表示するためにアカウントを登録する必要はありません。これは、インターフェイスドキュメントの表示やインターフェイスのテストに便利です。API管理プロジェクトの概要ページに移動し、オンライン共有プロジェクト設定をクリックして、プロジェクトのオンライン共有機能を有効または無効にします。

いつでもオン・オフが可能です。共有後は、ログインせずに共有して閲覧したい方に簡単にサポートを提供できます。サポート設定パスワードにアクセスする必要がある場合は、次の図に示すように設定できます。

また、訪問者が実行できる操作を設定することもできます。APIドキュメントの表示、APIテストの実施、ステータスコードドキュメントの表示、プロジェクトドキュメントの表示などです。例:[詳細APIドキュメント]、[APIテストの開始]、[モックAPIの表示]、[ステータスコードドキュメントの表示]、[プロジェクトドキュメントの表示]を表示したり、[プロジェクト環境]の情報を表示したりできます。

APIドキュメントを表示する:

APIテストの開始:いつでもAPIのテストを開始し、APIを確認します

モックを表示:さまざまな期待値を表示し、実際のリターンデータをシミュレートします

ステータスコードのドキュメント:さまざまな返品ステータスコードの意味を示します

環境の切り替え:開いた後、プロジェクト環境を表示できます。訪問者は、プロジェクト共有ページの右上にある環境切り替えメニューを確認できます。開発環境、テスト環境、本番環境など、訪問者が見ることができるプロジェクト環境情報を設定します。アドレスプレフィックス情報を要求します。デフォルトの環境は切り替えできません。

プロジェクトドキュメント:プロジェクトに添付されたさまざまなテキストの説明、写真、ファイルなど

APIツールはプロジェクトの柔軟性を向上させます。適切なAPI管理ツールを選択すると、プロジェクトプロセスをより適切に管理できるようになります。Eolinker:www.eolinker.com

おすすめ

転載: blog.csdn.net/qq_40857096/article/details/112727218