APIのステータス

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

APIステータスフィールドは、社内チーム向けのApidogアプリ内と、外部ユーザー向けのApidogで生成されたAPIドキュメントの両方で確認できる。

APIステータスの使い方

ApidogでAPIを指定する際、そのステータスを選択できる。新しく作成されたAPIは、デフォルトで 開発中 に設定される。

API仕様では、各ステータス名の前に色付きの丸印が付いており、異なるステータスを表している。この色分けシステムにより、APIディレクトリツリーで各APIとそのステータスを素早く見分けることができる。

色分けでは、青が 開発中、赤が テスト中 、グレーが 非推奨 を表す。丸印のないAPIは リリース済み とみなされ、特別な注意が必要ないことを示している。

公開されたドキュメントでも、これらの色付き丸印でAPIのステータスが表示される。

チームによって開発プロセスは異なり、必要なAPIステータスも様々だ。Apidogでは、チームの要件に応じて使用するAPIステータスをカスタマイズして選択できる。

「設定」 > 「一般設定」 > 「機能設定」 > 「API機能設定」セクションで、必要なAPIステータスを設定して有効にできる。

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

A: 各ステータスは特定の機能に対応しているため、新しいステータスのカスタマイズはサポートしていない。チームのニーズに最も合うステータスを既存のリストから選択して使用できる。