创建接口
POST
/api/v1/projects/{projectId}/http-apis
P0
请求参数
Path 参数
projectId
string
必需
示例值:
{{projectId}}
Query 参数
locale
string
可选
默认值:
zh-CN
Header 参数
X-Apifox-Version
enum<string>
必需
枚举值:
2024-01-20
默认值:
2024-01-20
Body 参数application/json
tags
array[string]
标签
requestBody
object (EndpiontRequestBody)
请求Body内容
type
string
可选
parameters
array [object]
必需
parameters
object (EndpiontRequestParameters)
可选
query
array [object]
可选
path
array [object]
可选
header
array [object]
可选
cookie
array [object]
可选
name
string
必需
description
string
可选
method
string
必需
path
string
必需
status
enum<string>
可选
枚举值:
designingpendingdevelopingintegratingtestingtestedreleaseddeprecatedexceptionobsolete
projectId
integer
可选
folderId
integer
可选
responses
array [object {6}]
可选
apiDetailId
integer
可选
code
integer
必需
contentType
enum<string> | enum<null>
内容格式
枚举值:
jsonxmlhtmlrawbinary
默认值:
json
defaultEnable
boolean | null
是否默认开启
数据库是 1默认开启，0不默认开启
jsonSchema
object (JSONSchema)
必需
name
string
必需
responseExamples
array [object {3}]
可选
name
string
必需
ordering
integer
必需
data
string
必需
auth
object
可选
advancedSettings
object
可选
responseChildren
array[string]
可选
示例
{
"tags": [
"string"
],
"requestBody": {
"type": "string",
"parameters": [
"string"
]
},
"parameters": {
"query": [
"string"
],
"path": [
"string"
],
"header": [
"string"
],
"cookie": [
"string"
]
},
"name": "string",
"description": "string",
"method": "string",
"path": "string",
"status": "designing",
"projectId": 0,
"folderId": 0,
"responses": [
{
"apiDetailId": 0,
"code": 0,
"contentType": "json",
"defaultEnable": true,
"jsonSchema": {},
"name": "string"
}
],
"responseExamples": [
{
"name": "string",
"ordering": 0,
"data": "string"
}
],
"auth": {},
"advancedSettings": {},
"responseChildren": [
"string"
]
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api.apifox.com/api/v1/projects/2078457/http-apis?locale=zh-CN' \
--header 'X-Apifox-Version;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"tags": [
"string"
],
"requestBody": {
"type": "string",
"parameters": [
"string"
]
},
"parameters": {
"query": [
"string"
],
"path": [
"string"
],
"header": [
"string"
],
"cookie": [
"string"
]
},
"name": "string",
"description": "string",
"method": "string",
"path": "string",
"status": "designing",
"projectId": 0,
"folderId": 0,
"responses": [
{
"apiDetailId": 0,
"code": 0,
"contentType": "json",
"defaultEnable": true,
"jsonSchema": {},
"name": "string"
}
],
"responseExamples": [
{
"name": "string",
"ordering": 0,
"data": "string"
}
],
"auth": {},
"advancedSettings": {},
"responseChildren": [
"string"
]
}'返回响应
🟢200成功
application/json
Body
data
object (Endpiont)
必需
tags
array[string]
标签
requestBody
object (EndpiontRequestBody)
请求Body内容
parameters
object (EndpiontRequestParameters)
必需
id
integer
必需
name
string
必需
description
string
必需
method
string
必需
path
string
必需
status
enum<string>
必需
枚举值:
designingpendingdevelopingintegratingtestingtestedreleaseddeprecatedexceptionobsolete
projectId
integer
必需
folderId
integer
可选
ordering
integer
必需
creatorId
integer
必需
editorId
integer
必需
responsibleId
integer
必需
createdAt
string
必需
updatedAt
string
必需
deletedAt
string | null
可选
responses
array[object (EndpiontResponse) {13}]
可选
auth
object
必需
advancedSettings
object
必需
responseChildren
array[string]
可选
success
boolean
必需
示例
{
"data": {
"tags": [
"string"
],
"requestBody": {
"type": "string",
"parameters": [
"string"
]
},
"parameters": {
"query": [
"string"
],
"path": [
"string"
],
"header": [
"string"
],
"cookie": [
"string"
]
},
"id": 0,
"name": "string",
"description": "string",
"method": "string",
"path": "string",
"status": "designing",
"projectId": 0,
"folderId": 0,
"ordering": 0,
"creatorId": 0,
"editorId": 0,
"responsibleId": 0,
"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"responses": [
{
"apiDetailId": 0,
"code": 0,
"contentType": "json",
"createdAt": "string",
"defaultEnable": true,
"deletedAt": 0,
"id": 0,
"jsonSchema": {},
"name": "string",
"ordering": 0,
"projectId": 0,
"updatedAt": "string",
"responseExamples": [
{
"name": "string",
"ordering": 0,
"data": "string"
}
]
}
],
"auth": {},
"advancedSettings": {},
"responseChildren": [
"string"
]
},
"success": true
}🟠403没有权限
🟠422参数错误
🟠403没有权限