Swagger拡張機能

1. APIのディレクトリを指定： x-apidog-folder

• /を使用してディレクトリを区切られます。\と/はエスケープする必要がある特殊文字です。\/は /になり、\\は\になります。

"paths": {
  "/pets": {
     "post": {
         ...
         "operationId": "addPet",
         "x-apidog-folder": "pet_store/pet_info"
     }
  }
}

• Swaggerの例：

@Operation(extensions = {
    @Extension(properties = {
            @ExtensionProperty(name = "apidog-folder", value = "pet_store/pet_info")})
})
public Response createPet() {...}

2. APIのステータスの確認：x-apidog-status

"paths": {
    "/pets": {
        "post": {
            ...
            "operationId": "addPet",
            "x-apidog-status": "released"
        }
    }
}

Swaggerの例：

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