Apidogの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

Status　ーー　ステータス

designing　ーー　設計中

pending　ーー　保留中

developing　ーー　開発中

integrating　ーー　インテグレーション中

testing　ーー　テスト中

tested　ーー　テスト済み

released　ーー　公開ずみ

deprecated　ーー　非推奨

exception　ーー　例外

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

Swaggerの例：

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