A
- API (Application Programming Interface)
- A contract that lets software systems communicate through defined operations and data formats.
- API reference
- Documentation organized around an API's operations, inputs, responses, schemas, and reusable components.
B
- Breaking change
- A change to an API contract that can make an existing client integration stop working or behave differently.
J
- JSON Schema
- A vocabulary for describing and validating JSON data. OpenAPI 3.1 aligns its Schema Object with JSON Schema 2020-12.
O
- OpenAPI
- A machine-readable standard for describing HTTP APIs, including their operations, parameters, request bodies, responses, and schemas.
- Operation
- One HTTP method on an API path, such as GET /books. An operation defines its parameters, request body, responses, and metadata.
S
- Schema
- A description of the structure, types, and validation rules for data used by an API.
- Spectral
- An open source linter for JSON and YAML documents. Speccy uses Spectral rules to report OpenAPI quality and consistency problems.
- Swagger
- The former name of the OpenAPI Specification. Swagger 2.0 documents are still common and are supported by Speccy.