APIs.io · API Governance Rules
APIs.io API Rules
Spectral linting rules defining API design standards and conventions for APIs.io.
37 Rules
error 13
warn 18
info 6
Rule Categories
apis
components
examples
get
info
no
openapi
operation
parameter
paths
post
request
response
schema
servers
tag
tags
Rules
warn
info-title-format
Info title should start with "APIs.io"
$.info.title
error
info-description-required
Info must have a description
$.info
error
info-version-required
Info must have a version
$.info
warn
info-contact-required
Info should include contact information
$.info
warn
openapi-version-31
Specs should use OpenAPI 3.1.x as established by the APIs.io API
$.openapi
error
servers-defined
Servers array must be defined
$
error
servers-https-only
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-prefix
Operation summaries should start with "APIs.io"
$.paths[*][get,post,put,patch,delete].summary
info
operation-summary-title-case
Operation summaries should use Title Case
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
All operations should have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
OperationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
tags-defined
Global tags array should be defined
$
warn
tag-description-required
All global tags should have descriptions
$.tags[*]
error
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][*].parameters[*]
warn
parameter-names-snake-case
Parameter names should use snake_case
$.paths[*][*].parameters[*].name
warn
request-body-description-required
Request bodies should have descriptions
$.paths[*][*].requestBody
warn
request-body-json-content
Request bodies should support application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-200-required
GET and POST operations must have a 2xx response
$.paths[*][get,post]
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
warn
response-400-recommended
Operations should include a 400 Bad Request response
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-recommended
Operations should include a 401 Unauthorized response
$.paths[*][get,post,put,patch,delete].responses
warn
response-500-recommended
Operations should include a 500 Internal Server Error response
$.paths[*][get,post,put,patch,delete].responses
info
schema-properties-snake-case
Schema property names should use snake_case
$.components.schemas[*].properties[*]~
info
schema-description-recommended
Component schemas should have descriptions
$.components.schemas[*]
warn
schema-type-defined
Schema objects should have a type defined
$.components.schemas[*]
info
components-security-schemes-defined
Security schemes should be defined in components
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
post-has-request-body
POST operations should have a request body
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
examples-on-schemas
Schema properties should include examples
$.components.schemas[*].properties[*]
info
apis-json-format-validation
APIs submitted to APIs.io should follow APIs.json format
$.paths[*][post].requestBody.content.application/json.schema