エンドポイントステータス

Apidog では、便利な組み込みフィールドとして エンドポイントステータス があります。このフィールドは、エンドポイントが開発中、テスト中、またはすでにリリース済みであるかを示すために設計されています。

エンドポイントステータスフィールドは、内部チームの参照用として Apidog アプリ内に表示されるだけでなく、外部ユーザー向けに Apidog によって生成される API ドキュメントにも表示されます。

エンドポイントステータスの利用

Apidog でエンドポイントを指定する際に、そのエンドポイントのステータスを選択できます。デフォルトでは、新しく作成されたエンドポイントは Developing に設定されます。

エンドポイント仕様では、各ステータス名の前に色付きのドットが付与され、エンドポイントのさまざまなステータスを示します。この色分けシステムにより、ユーザーはエンドポイントディレクトリツリー内で、エンドポイントとそれぞれのステータスを素早く区別できます。

色	ステータス	説明
青	Developing	エンドポイントは現在開発中です
赤	Testing	エンドポイントはテスト中です
グレー	Deprecated	エンドポイントは非推奨です
ドットなし	Released	エンドポイントはリリース済みで、特別な注意は不要です

公開されたドキュメントでも、これらの色付きドットがエンドポイントのステータスを示すために使用されます。

チームごとに開発プロセスは異なる場合があり、必要なエンドポイントステータスもそれに応じて変わることがあります。Apidog では、チームが特定の要件に基づいて、使用するエンドポイントステータスをカスタマイズして選択できます。

目的のエンドポイントステータスは、Settings > General Settings > Feature Settings > Endpoint Feature Settings で設定および有効化できます。

Q: 新しいステータスをカスタマイズできますか？

A: 各ステータスは特定の機能に対応しているため、新しいステータスのカスタマイズはサポートされていません。チームのニーズに最も適したステータスを、一覧にあるステータスから選択できます。