获取接口目录详情 - Apifox 开放 API

请求参数

Path 参数

projectId

string

必需

示例值:

id

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

返回响应

🟢200成功

application/json

Body

success

boolean

必需

data

object (EndpiontFolder)

必需

id

integer

必需

name

string

必需

type

string

必需

projectId

integer

必需

parentId

integer

必需

children

array[string]

必需

serverId

string

必需

preProcessors

array [object]

必需

postProcessors

array [object]

必需

identityPattern

object (IdentityPattern)

分组的接口唯一标识

必需

auth

object

必需

description

string | null

必需

ordering

integer

必需

createdAt

string

必需

updatedAt

string

必需

creatorId

integer

必需

editorId

integer

必需

docId

integer | null

可选

默认值:

0

示例

{
    "success": true,
    "data": {
        "id": 0,
        "name": "string",
        "type": "string",
        "projectId": 0,
        "parentId": 0,
        "children": [
            "string"
        ],
        "serverId": "string",
        "preProcessors": [
            {}
        ],
        "postProcessors": [
            {}
        ],
        "identityPattern": {
            "httpApi": {
                "type": "query",
                "bodyType": "formdata",
                "fields": [
                    "string"
                ]
            }
        },
        "auth": {},
        "description": "string",
        "ordering": 0,
        "createdAt": "string",
        "updatedAt": "string",
        "creatorId": 0,
        "editorId": 0,
        "docId": 0
    }
}

🟠403没有权限

🟠422参数错误

🟠403没有权限