Apidog · API Governance Rules
Apidog API Rules
Spectral linting rules defining API design standards and conventions for Apidog.
20 Rules
error 8
warn 12
Rule Categories
info
openapi
operation
parameter
paths
post
response
security
servers
tag
Rules
warn
info-title-prefix
API title must start with 'Apidog'.
$.info
error
info-description-required
API must have a description.
$.info
error
info-version-required
API must have a version.
$.info
warn
openapi-version-3
Specs must use OpenAPI 3.x.
$
error
servers-defined
Servers must be defined.
$
error
servers-https
All server URLs must use HTTPS.
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case.
$.paths
warn
paths-no-trailing-slash
Paths must not have a trailing slash.
$.paths
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with 'Apidog'.
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camelcase
OperationId must use camelCase.
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
tag-description-required
All tags must have a description.
$.tags[*]
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a 2xx response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-required
Protected operations should have a 401 response.
$.paths[*][post,put,patch,delete].responses
error
security-scheme-defined
Security schemes must be defined in components.
$.components.securitySchemes
warn
post-has-request-body
POST operations should have a request body.
$.paths[*].post