Apidog OpenAPI/Swagger Specificaiton Extensions
Specify the Folder to Which an Endpoint Belongs
1.
x-apidog-folder field. If this field does not exist, it will use the first value in the tags field.2.
/ to separate Multi-level folders. Note that both backslash \ and forward slash / are special characters that require escaping. To represent the character forward slash /, please use \/, and to represent the character \, please use \\."paths": {
"/pets": {
"post": {
...
"operationId": "addPet",
"x-apidog-folder": "Pet Store/Pet Information"
}
}
}Endpoint Status
x-apidog-status| Status | Description |
|---|---|
| (Designing) | designing |
| (Pending) | pending |
| (Developing) | developing |
| (Integrating) | integrating |
| (Testing) | testing |
| (Tested) | tested |
| (Released) | released |
| (Deprecated) | deprecated |
| (Exception) | exception |
| (Obsolete) | obsolete |
| (To be Deprecated) | to be deprecated |
"paths": {
"/pets": {
"post": {
...
"operationId": "addPet",
"x-apidog-status": "released"
}
}
}Maintainer
x-apidog-maintainer. Its value is the nickname or username of the Apidog user within the team."paths": {
"/pets": {
"post": {
...
"x-apidog-maintainer": "david"
}
}
}@Operation(extensions = {
@Extension(properties = {
@ExtensionProperty(name = "apidog-maintainer", value = "david")})
})
public Response createPet() {...}Modified atΒ 2025-05-14 06:56:58