Edge Security Acceleration:API セキュリティ設定

ファイル形式とサイズ

• フォーマット: スキーマファイルは .yml、 .yaml、または .json 形式である必要があります。

• サイズ: 最大ファイルサイズは 58 KB です。より大きなスキーマの場合は、 .json 形式を使用し、アップロードする前に圧縮してください。

スキーマのコンテンツ

例

以下は、.json スキーマファイルの例です。

{
    "openapi": "3.0.0",
    "info": {
        "title": "example",
        "description": "example",
        "version": "1.0"
    },
    "servers": [
    {
      "url": "https://example1.aliyun.com",
      "description": "example1 url"
    },
    {
      "url": "https://example2.aliyun.com",
      "description": "example2 url"
    }
    ],
    "components": {
        "schemas": {
            "ParamsObject": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "value": {
                        "type": "string"
                    }
                },
                "required": [
                    "id",
                    "value"
                ]
            }
        }
    },
    "paths": {
        "/example/{param1}": {
            "get": {
                "operationId": "getexampleById",
                "parameters": [
                    {
                        "name": "param1",
                        "in": "path",
                        "required": true,
                        "description": "id",
                        "schema": {
                            "type": "integer",
                            "format": "int32"
                        }
                    }
                ]
            }
        },
        "/api1": {
            "post": {
                "operationId": "post_api1",
                "summary": "post api1 request",
                "parameters": [],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ParamsObject"
                            }
                        }
                    }
                }
            },
            "get" :{
                "operationId": "get_api1",
                "summary": "get api1 request",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "integer",
                            "format": "int32"
                        }
                    },
                    {
                        "name": "name",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        }
    }
}

フィールドの説明

公開鍵は JSON Web Key (JWK) 形式である必要があります。JWK 公開鍵には kid および alg フィールドが含まれている必要があります。各フィールドの説明は次のとおりです:

• kty: キータイプ。例: Elliptic Curve の場合は EC。

• use: 公開鍵の用途。例: デジタル署名の場合は sig。

• crv: 楕円曲線のタイプ。例: NIST 標準の P-256 曲線の場合は P-256。

• kid: カスタムキー識別子。例: esa。キー選択を有効にするには、JWK に kid フィールドを含める必要があります。リクエスト内の JWT クレームにも kid フィールドを含める必要があります。このフィールドは、トークンキーのローテーションに使用されます。

• x: 楕円曲線公開鍵の x 座標。

• y: 楕円曲線公開鍵の y 座標。

• alg: アルゴリズム識別子。現在サポートされているのは、SHA-256 を使用した ECDSA 署名アルゴリズムである ES256 のみです。

例

{
  "kty": "EC",
  "use": "sig",
  "crv": "P-256",
  "kid": "esa",
  "x": "QG3VFVwUX4IatQvBy7sqBvvmticCZ-eX5-nbtGKBOfI",
  "y": "A3PXCshn7XcG7Ivvd2K_DerW4LHAlIVKdqhrUnczTD0",
  "alg": "ES256"
}