创建环境 - Apifox 开放 API

请求参数

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}}

Body 参数application/json

name

string

必需

baseUrls

string

必需

序列化后的 JSON

variables

string

必需

序列化后的 JSON

visibility

string

可选

protected 表示共有

示例

{
    "name": "测试环境2",
    "baseUrls": "{ \"default\": \"http://127.0.0.1:8888\"}",
    "visibility": "protected",
    "variables": "[{\"name\":\"envVar\",\"value\":\"1\",\"description\":\"envVar desc\",\"isFixedValue\":true}]"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://api.apifox.com/api/v1/projects/2078457/environments?locale=zh-CN' \
--header 'X-Apifox-Version;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "测试环境2",
    "baseUrls": "{ \"default\": \"http://127.0.0.1:8888\"}",
    "visibility": "protected",
    "variables": "[{\"name\":\"envVar\",\"value\":\"1\",\"description\":\"envVar desc\",\"isFixedValue\":true}]"
}'

返回响应

🟢200成功

application/json

Body

data

object (Environment)

必需

parameters

object | null

必需

variables

array[object (Variable) {2}] | null

环境变量

必需

id

integer

必需

name

string

必需

baseUrl

string

必需

creatorId

integer

必需

editorId

integer

必需

projectId

integer

必需

ordering

integer

必需

updatedAt

string

必需

createdAt

string

必需

servers

array [object {3}]

可选

registrationCenters

array [object]

可选

success

boolean

必需

示例

{
    "data": {
        "baseUrl": "http://127.0.0.1:8888",
        "baseUrls": {
            "default": "http://127.0.0.1:8888"
        },
        "parameters": {
            "cookie": [],
            "query": [],
            "header": [],
            "body": []
        },
        "variables": [
            {
                "name": "envVar",
                "value": "1",
                "description": "envVar desc",
                "isFixedValue": true
            }
        ],
        "registrationCenters": [],
        "tags": [],
        "type": "normal",
        "id": 18411999,
        "projectType": "HTTP",
        "name": "测试环境",
        "visibility": "protected",
        "creatorId": 377134,
        "editorId": 377134,
        "projectId": 2074249,
        "ordering": 30,
        "updatedAt": "2024-02-27T03:03:24.329Z",
        "createdAt": "2024-02-27T03:03:24.329Z"
    },
    "success": true
}

🟠403没有权限

🟠422参数错误

🟠403没有权限