OAS 2 このページは OpenAPI Specification ver. 2 (旧 Swagger) に適用されます。
最新バージョンについては、OpenAPI 3 ページをご覧ください。

Swagger 拡張機能

拡張機能、またはベンダー拡張機能は、x-logo のように x- で始まるカスタムプロパティです。標準の Swagger 仕様ではカバーされていない追加機能を記述するために使用できます。Swagger をサポートする多くの API 関連製品は、Amazon API Gateway、ReDoc、APIMatic など、独自の属性をドキュメント化するために拡張機能を利用しています。拡張機能は、API 仕様のルートレベルと以下の場所でサポートされています。

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

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

例

Amazon API Gateway カスタムオーソライザーを使用する API には、次のような拡張機能が含まれます。

securityDefinitions:
  APIGatewayAuthorizer:
    type: apiKey
    name: Authorization
    in: header
    x-amazon-apigateway-authtype: oauth2
    x-amazon-apigateway-authorizer:
      type: token
      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
      authorizerCredentials: arn:aws:iam::account-id:role
      identityValidationExpression: "^x-[a-z]+"
      authorizerResultTtlInSeconds: 60

  

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