Apidog OpenAPI仕様拡張
APIが属するフォルダを指定
1.
x-apidog-folderフィールドを優先的に使用する。このフィールドが存在しない場合は、tagsフィールドの最初の値を使用する。2.
/を使用する。バックスラッシュ\とスラッシュ/は特殊文字なのでエスケープが必要。スラッシュ/を表すには\/を、バックスラッシュ\を表すには\\を使用する。"paths": {
"/pets": {
"post": {
...
"operationId": "addPet",
"x-apidog-folder": "Pet Store/Pet Information"
}
}
}APIのステータス
x-apidog-status| ステータス | 説明 |
|---|---|
| (Designing) | 設計中 |
| (Pending) | 保留中 |
| (Developing) | 開発中 |
| (Integrating) | 統合中 |
| (Testing) | テスト中 |
| (Tested) | テスト済み |
| (Released) | リリース済み |
| (Deprecated) | 非推奨 |
| (Exception) | 例外 |
| (Obsolete) | 廃止 |
| (To be Deprecated) | 非推奨予定 |
"paths": {
"/pets": {
"post": {
...
"operationId": "addPet",
"x-apidog-status": "released"
}
}
}メンテナー
x-apidog-maintainer。その値はチーム内のApidogユーザーのニックネームまたはユーザー名。"paths": {
"/pets": {
"post": {
...
"x-apidog-maintainer": "david"
}
}
}@Operation(extensions = {
@Extension(properties = {
@ExtensionProperty(name = "apidog-maintainer", value = "david")})
})
public Response createPet() {...}Modified at 2025-01-13 08:07:14