Apis - List All

リファレンス

サービス:: API Center

API バージョン:: 2024-02-01-preview

ワークスペース間で API のコレクションを一覧表示します。

GET https://{serviceName}.data.{region}.azure-apicenter.ms/apis?api-version=2024-02-01-preview

省略可能なパラメーターを含む:

GET https://{serviceName}.data.{region}.azure-apicenter.ms/apis?api-version=2024-02-01-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI パラメーター

名前	/	必須	型	説明
region	path	True	string	リージョン名
serviceName	path	True	string	リージョン固有の API センターサービス名
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
maxpagesize	query		integer (int32)	ページあたりの結果項目の最大数。
skip	query		integer (int32)	スキップする結果項目の数。
top	query		integer (int32)	返される結果項目の数。

応答

名前	型	説明
200 OK	PagedApiAll	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

PagedApiAll

要求は成功しました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

AadOauth2Auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://azure-apicenter.net/user_impersonation

例

Apis_ListAll

要求のサンプル

HTTP

GET https://{serviceName}.data.{region}.azure-apicenter.ms/apis?api-version=2024-02-01-preview

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "echo-api",
      "title": "Echo API",
      "kind": "rest",
      "lastUpdated": "2023-12-18T18:49:11.878Z",
      "description": "A simple HTTP request/response service.",
      "lifecycleStage": "design",
      "termsOfService": {
        "url": "https://contoso.com/terms-of-service"
      },
      "license": {
        "name": "default",
        "url": "https://contoso.com/license"
      },
      "externalDocumentation": [
        {
          "title": "Onboarding docs",
          "description": "Learn how to onboard to the Echo API.",
          "url": "https://docs.contoso.com"
        }
      ],
      "contacts": [
        {
          "name": "Contoso support",
          "url": "https://support.contoso.com",
          "email": "support@contoso.com"
        }
      ]
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

定義

名前	説明
Api	API リソースモデル。
ApiKind	API の種類
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Contact	API の連絡先情報
ExternalDocumentation	API 外部ドキュメントモデル
License	API ライセンスモデル
LifecycleStage	API ライフサイクルステージ
PagedApiAll	ワークスペース間での API 項目のページングコレクション。
TermsOfService	API サービスの使用条件

Api

Object

API リソースモデル。

名前	型	説明
contacts	Contact[]	API の連絡先。
customProperties	object	API エンティティに対して定義されたカスタムメタデータ。
description	string maxLength: 1000	API の説明
externalDocumentation	ExternalDocumentation[]	外部ドキュメント
kind	ApiKind	API の種類。たとえば、REST や GraphQL などです。
lastUpdated	string (date-time)	最終更新日時。
license	License	API のライセンス情報。
lifecycleStage	LifecycleStage	API の現在のライフサイクルステージ。
name	string maxLength: 50	API 識別子。
summary	string maxLength: 200	API の簡単な説明。
termsOfService	TermsOfService	API のサービス条件。
title	string maxLength: 50	API の名前。

ApiKind

列挙

API の種類

値	説明
graphql	GraphQL API
grpc	GRPC API
rest	REST API
soap	SOAP API
webhook	Webhook API
websocket	Websocket API

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

Contact

Object

API の連絡先情報

名前	型	説明
email	string maxLength: 100	連絡先のメールアドレス。
name	string maxLength: 100	連絡先の名前。
url	string (uri)	連絡先の URL。

ExternalDocumentation

Object

API 外部ドキュメントモデル

名前	型	説明
description	string maxLength: 1000	ドキュメントの説明。
title	string maxLength: 50	ドキュメントのタイトル。
url	string (uri)	ドキュメントを指す URL。

License

Object

API ライセンスモデル

名前	型	説明
identifier	string maxLength: 200	API の SPDX ライセンス情報。識別子フィールドは、URL フィールドと相互に排他的です。
name	string maxLength: 50	ライセンスの名前。
url	string (uri)	ライセンスの詳細を指す URL。 URL フィールドは、識別子フィールドと相互に排他的です。

LifecycleStage

列挙

API ライフサイクルステージ

値	説明
deprecated	API は非推奨の段階にあります
design	API が設計段階にある
development	API は開発段階にあります
preview	API はプレビュー段階にあります
production	API は運用段階にあります
retired	API は廃止された段階にあります
testing	API はテスト段階にあります

PagedApiAll

Object

ワークスペース間での API 項目のページングコレクション。

名前	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	Api[]	このページの API 項目

TermsOfService

Object

API サービスの使用条件

名前	型	説明
url	string (uri)	サービス条件を指す URL。

次の方法で共有

Apis - List All

URI パラメーター

応答

セキュリティ

AadOauth2Auth

スコープ

例

Apis_ListAll

要求のサンプル

応答のサンプル

定義

Api

ApiKind

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Contact

ExternalDocumentation

License

LifecycleStage

PagedApiAll

TermsOfService