Swagger 拡張

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

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

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

例

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

1
securityDefinitions:
2
  APIGatewayAuthorizer:
3
    type: apiKey
4
    name: Authorization
5
    in: header
6
    x-amazon-apigateway-authtype: oauth2
7
    x-amazon-apigateway-authorizer:
8
      type: token
9
      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
10
      authorizerCredentials: arn:aws:iam::account-id:role
11
      identityValidationExpression: "^x-[a-z]+"
12
      authorizerResultTtlInSeconds: 60

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