Apifox 开放 API
  1. 项目管理
Apifox 开放 API
  • 接口
    • 获取接口详情
      GET
    • 创建接口
      POST
    • 删除接口
      DELETE
    • 修改接口
      PUT
  • 接口目录
    • 获取接口目录详情
      GET
    • 创建接口目录
      POST
    • 修改接口目录
      PUT
    • 删除接口目录
      DELETE
    • 获取接口目录列表
      GET
  • 环境管理
    • 创建环境
      POST
    • 获取环境详情
      GET
    • 删除环境
      DELETE
    • 修改环境
      PUT
  • 全局参数
    • 获取全局参数
      GET
    • 设置全局参数
      PUT
  • 项目管理
    • 获取项目设置
      GET
    • 修改项目设置
      PUT
    • 获取当前用户的项目列表
      GET
  1. 项目管理

修改项目设置

PUT
https://api.apifox.com/api/v1/projects/{projectId}/settings

请求参数

Path 参数
projectId
string 
必需
示例值:
{{projectId}}
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
servers
array [object {2}] 
可选
name
string 
必需
id
string 
必需
language
enum<string> 
可选
枚举值:
zh-CNen-US
示例
{
    "servers": [
        {
            "id": "default",
            "name": "Default Server"
        },
        {
            "id": "{% mock 'guid' %}",
            "name": "GUID Server"
        }
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https://api.apifox.com/api/v1/projects/2078457/settings?locale=zh-CN' \
--header 'X-Apifox-Version;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "servers": [
        {
            "id": "default",
            "name": "Default Server"
        },
        {
            "id": "{% mock '\''guid'\'' %}",
            "name": "GUID Server"
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
data
object (ProjectSettings) 
可选
apiStatuses
array[string]
必需
servers
array [object {2}] 
必需
preProcessors
array[string]
必需
postProcessors
array[string]
必需
auth
object 
必需
cloudMock
object 
必需
initialDisabledMockIds
array[integer]
必需
mockSettings
object 
必需
gateway
array [object {4}] 
必需
advancedSettings
object 
必需
id
integer 
必需
projectId
integer 
必需
creatorId
integer 
必需
editorId
integer 
必需
language
enum<string> 
必需
枚举值:
zh-CNen-USja-JPpt-PT
createdAt
string 
可选
updatedAt
string 
可选
deletedAt
null 
可选
httpResponseTemplate
object  | null 
可选
templateParameters
array [object {4}]  | null 
可选
success
boolean 
必需
示例
{
    "data": null,
    "success": true
}
🟠403没有权限
🟠422参数错误
🟠403没有权限
🟠400强制升级
修改于 2024-03-22 08:16:31
上一页
获取项目设置
下一页
获取当前用户的项目列表
Built with