OpenAPI 拡張

拡張機能 (「仕様拡張」または「ベンダー拡張」とも呼ばれる) は、x- で始まるカスタムプロパティ (例: x-logo) です。これらは、OpenAPI 標準にデフォルトで含まれていない追加情報や機能を追加するために使用されます。たとえば、Amazon API Gateway、ReDoc、APIMatic、Fern を含む多くのツールは、製品固有の詳細を含めるために拡張機能を使用しています。

拡張機能の追加

拡張機能は、API 仕様のルートレベルと、次の場所でサポートされています。

info セクション
paths セクション、個々のパスと操作
操作パラメータ
レスポンス
タグ
セキュリティスキーム

拡張機能の値は、プリミティブ、配列、オブジェクト、または null にすることができます。値がオブジェクトまたはオブジェクトの配列である場合、オブジェクトのプロパティ名は x- で始まる必要はありません。

例

Amazon API Gateway カスタムオーソライザーを使用する API は、これに類似した拡張機能を含む場合があります。

1
components:
2
  securitySchemes:
3
    APIGatewayAuthorizer:
4
      type: apiKey
5
      name: Authorization
6
      in: header
7
      x-amazon-apigateway-authtype: oauth2
8
      x-amazon-apigateway-authorizer:
9
        type: token
10
        authorizerUri: arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:account-id:function:function-name/invocations
11
        authorizerCredentials: arn:aws:iam::account-id:role
12
        identityValidationExpression: "^x-[a-z]+"
13
        authorizerResultTtlInSeconds: 60

お探しのものが見つかりませんでしたか？コミュニティに質問する
間違いを見つけましたか？お知らせください