跳到主要内容

Apifox Swagger 扩展

指定接口目录​

  1. Apifox 会优先使用 x-apifox-folder 字段，如果不存在该字段，则会使用 tags 字段里的第一个值。

  2. 多级目录使用斜杠/分隔。其中\和/为特殊字符，需要转义，\/表示字符/，\\表示字符\。

"paths": {
  "/pets": {
     "post": {
         ...
         "operationId": "addPet",     
         "x-apifox-folder": "宠物店/宠物信息"
     }
  }
}

Swagger 注解示例：

@Operation(extensions = {
    @Extension(properties = {
            @ExtensionProperty(name = "x-apifox-folder", value = "宠物店/宠物信息")})
})
public Response createPet() {...}

接口状态​

查看接口状态：x-apifox-status。

状态英文说明
设计中designing
待确定pending
开发中developing
联调中integrating
测试中testing
已测完tested
已发布released
有异常exception
将废弃deprecated
已废弃obsolete
"paths": {
    "/pets": {
        "post": {
            ...
            "operationId": "addPet",     
            "x-apifox-status": "released"
        }
    }
}

Swagger 注解示例：

@Operation(extensions = {
    @Extension(properties = {
            @ExtensionProperty(name = "x-apifox-status", value = "released")})
})
public Response createPet() {...}

责任人​

指定接口的责任人：x-apifox-maintainer。

其值为 Apifox 用户在团队内的昵称，或者用户名。

"paths": {
    "/pets": {
        "post": {
            ...   
            "x-apifox-maintainer": "david" // "团队内昵称"或“用户账户名”，优先使用“团队内昵称”，未配置“团队内昵称”时才使用“用户账户名”
        }
    }
}

Swagger 注解示例：

@Operation(extensions = {
    @Extension(properties = {
            @ExtensionProperty(name = "apifox-maintainer", value = "david")})
})
public Response createPet() {...}