获取全局参数

GET

/api/v1/projects/{projectId}/common-parameters

请求参数

Path 参数

projectId

string

必需

示例值:

Query 参数

locale

string

可选

默认值:

zh-CN

Header 参数

X-Apifox-Version

enum<string>

必需

开放 API 版本号，必填，否则会报错

枚举值:

2024-01-20

默认值:

2024-01-20

Authorization

string

必需

身份认证，格式为Bearer 个人访问令牌，查看如何获取个人访问令牌

默认值:

Bearer {{access_token}}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://api.apifox.com/api/v1/projects/2078457/common-parameters?locale=zh-CN' \
--header 'X-Apifox-Version;' \
--header 'Authorization;'

返回响应

🟢200成功

application/json

Body

success

boolean

必需

data

object | null

必需

parameters

object (CommonParameters)

必需

integer

必需

projectId

integer

必需

creatorId

integer

必需

editorId

integer

必需

createdAt

string

必需

updatedAt

string

必需

deletedAt

string | null

必需

示例

{
  "success": true,
  "data": {
    "parameters": {
      "query": [
        {
          "name": "string",
          "type": "string",
          "defaultValue": "string",
          "defaultEnable": true,
          "description": "string"
        }
      ],
      "body": [
        {
          "name": "string",
          "type": "string",
          "defaultValue": "string",
          "defaultEnable": true,
          "description": "string"
        }
      ],
      "header": [
        {
          "name": "string",
          "type": "string",
          "defaultValue": "string",
          "defaultEnable": true,
          "description": "string"
        }
      ],
      "cookie": [
        {
          "name": "string",
          "type": "string",
          "defaultValue": "string",
          "defaultEnable": true,
          "description": "string"
        }
      ]
    },
    "id": 0,
    "projectId": 0,
    "creatorId": 0,
    "editorId": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string"
  }
}

🟠422参数错误

修改环境

设置全局参数