Edge Security Acceleration：API架構合規驗證

分析不合規請求

配置完成結構描述驗證後，ESA將持續對API請求進行檢測。您可以在結構描述驗證頁簽單擊API列表功能表列的篩選按鈕，選擇對應的架構篩選出需要分析的架構，即可為您展示相應的API，並在不合規請求列中展示近24小時的不合規請求數。

不合規請求可能由幾個原因導致：

• 用戶端行為問題：用戶端出現傳參格式錯誤（如需JSON卻傳表單資料）、必填參數缺失、類型不符（字串傳布爾值）等問題時，可能導致不合規請求數增加。出現此類問題時，需要檢查業務前端設計，增加錯誤偵測機制、提交提醒等。

• 異常攻擊行為：當攻擊者進行注入攻擊、暴力破解等攻擊行為時，可能導致不合規請求數增加。出現此類問題時，您的業務系統可能正在遭受攻擊，建議您更改執行動作為攔截，並配置更嚴格WAF規則。

分析無架構的API

當您成功上傳架構檔案後，符合架構的API將自動綁定對應的架構。您可以在結構描述驗證頁簽單擊無架構的 API 數量欄的篩選按鈕進行篩選查看無架構的API列表。

針對無架構的API，ESA無法進行不合規請求統計，因此針對這類API對業務可能並不安全。無架構的API可能來自：

• 架構中遺漏：在上傳的架構中遺漏了該類API。您可以核對列表中的API路徑、主機記錄、請求方案等資訊特徵，重新調整上傳架構檔案解決。

• API不合規範：已發現的API不符合規範。在API開發過程中，出現不規範開發，需要重新對不合規API進行修改或重構，通常包含以下幾類：

  • 路徑不規範：API的路徑有誤，如正確的paths應為/users，錯誤時寫為/user。

  • HTTP方法誤用：方法未遵循語義化原則，如用DELETE對應/users/delete/123的路徑，錯誤時寫為GET方法。

  • 狀態代碼濫用：API響應狀態代碼有誤，如所有響應需返回200 OK，錯誤時在Body中寫{ "responses": “500” }。

  • 輸入輸出結構混亂：輸入輸出內容有誤，如輸入應包含email欄位，但錯寫至輸出中。

類型和大小

結構描述驗證檔案僅支援 .yml、.yaml 或 .json 格式，最大上傳大小為 58KB。如果上傳架構檔案過大，可以使用.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"
                        }
                    }
                ]
            }
        }
    }
}