このページは Apigee と Apigee ハイブリッドに適用されます。
[API] ページには、API に関する詳細情報が掲載されています。[API] の一覧ページから任意の API を選択すると、その API のページの [Overview] タブが表示されます。
[Overview] タブには、次のセクションがあります。
General
[General] ペインには、API に関する次のような主要な情報が示されます。
- Display name: API の表示名。API の登録時に定義されます。表示名を編集する方法については、API 登録の詳細を編集するをご覧ください。
- Description: API の説明。API の登録時に定義されます。説明を編集する方法については、API 登録の詳細を編集するをご覧ください。
- システムおよびカスタムの分類要素
- Document version: 現在デプロイメントに割り当てられている仕様のリビジョンを開くリンク。このボタンは、API に推奨のデプロイセットが設定され、そのデプロイにバージョンが割り当てられている場合にのみ表示されます。
- Get access: この API にアクセスする手順。これらの手順の変更方法については、デプロイメントを編集するをご覧ください。このボタンは、推奨のデプロイセットがある場合にのみ表示されます。
公開 API を通じてアタッチされた不明なラベルやタグは、UI に表示されません。表示されるのは、既知の分類を定義するラベルのみです。
分類の値には、テキストの説明または URL を割り当てることができます。このペインで、分類値にテキストの説明が割り当てられている場合、値の横に 情報アイコンが表示されます。このアイコンにカーソルを合わせると、説明が表示されます。値が URL の場合、表示される分類値はハイパーリンクになり、新しいブラウザタブで URL が開きます。詳細については、分類の追加をご覧ください。
API を編集する
API 登録の詳細を編集するをご覧ください。
API を削除する
API を削除するをご覧ください。
Scorecard
スコアカードは、API の品質がどのように測定されているかを把握するのに役立ちます。API のポートフォリオ全体にわたって慎重に検討して評価を行うことが、設計基準、セキュリティ プロファイル、信頼性など、ビジネスにとって重要なさまざまな分野で一貫性を保つことにつながります。API Hub は OpenAPI lint がすでに構成されている状態で提供されています。
スコアカードは、簡単に 1 つの数量に減らすことができないスコアのグループを表します。
スコアは、API の品質を示す単一の値です。品質はあらゆるコンテキスト（設計、信頼性、コンプライアンスなど）で定義でき、よく意見の分かれる問題となります。
スコアカードを非表示にする
すべての API のスコアカード UI を非表示にする方法については、API スコアカードを無効または有効にするをご覧ください。
スコアカードのバージョンを選択する
[Score this spec] のプルダウン リストからスコアカードに使用するバージョンを選択します。
各要素の意味は次のとおりです。
- Latest: この仕様のリビジョンには最新のアップロードのタイムスタンプが付いています。
- Recommended: この仕様には、推奨されるデプロイに割り当てられたリビジョンのいずれかが含まれています。API のユーザーはこの仕様を使用してください。
スコアカードをカスタマイズする
スコアカードをカスタマイズおよび構成するには、レジストリ コマンドライン ツールを使用します。
関連情報: How are Scores calculated?
スコアカードのエラーと警告の横にステータス アイコンを表示する場合は、しきい値を定義します。
各要素の意味は次のとおりです。
| 種類 | アイコン | 説明 |
|---|---|---|
| アラート |  |
しきい値がアラートとして定義された範囲内にある場合に、このアイコンを表示します。 |
| 警告 |  |
しきい値が警告として定義された範囲内にある場合に、このアイコンを表示します。 |
| OK |  |
しきい値が OK として定義された範囲内にある場合に、このアイコンを表示します。 |
lint の概要
API Hub スコアカードのデフォルト構成では、API Hub にアップロードされた OpenAPI v2 と OpenAPI v3 の仕様に関する lint 警告と lint エラーが報告されます。API Hub とレジストリには、Spectral に基づくデフォルトのリンターが含まれています。このリンターは、lint チェック機能の参照例として提供されています（Spectral 自体のサポートは想定されていません）。一般的なエラーからのノイズを軽減するために一部の例外を有効にした OpenAPI Rules ルールセットを使用しています。現時点では、カスタム リンターを使用した拡張はサポートされていません。
リンター構成の更新手順については、API Style Guides in the Registry をご覧ください。
Deployments
[Deployments] タブに、API エディタで構成された API のすべてのデプロイが表示されます。デプロイメントは API がデプロイされているライブ環境を表します。デプロイメントは環境名で並べ替えられます（降順）。次の情報が表示されます。
- 環境
- ドキュメント
- 推奨されるデプロイ指標
- ゲートウェイ
- 使用ガイダンス
- 外部チャネル
- アクセスの取得
詳細については、デプロイメントを管理するをご覧ください。
Versions
[Versions] タブには、API 向けに定義されているすべてのバージョンが表示されます。バージョンはバージョン番号で並べ替えられます（降順）。次の情報が表示されます。
- バージョン
- ライフサイクル ステージ
- 前回のリビジョン
- サポート終了日
詳細については、バージョンの管理をご覧ください。
Related
API の [Overview] ページの下部にある [Related] ペインには、API に関するその他の情報へのリンクがあります。たとえば、ソースコードの実装、設計ドキュメント、インフラストラクチャ システムなどです。詳細については、Related をご覧ください。
Dependencies
API の [Overview] ページの下部にある [Dependencies] ペインには、API のすべての依存関係が一覧表示されます。他の内部 API（API Hub に存在するもの）、外部サードパーティ API（API Hub に存在しないもの）、その他の本番環境システムなどがあります。たとえば、データベースやストレージ ソリューションが挙げられます。詳細については、Dependencies をご覧ください。
