Api linting
API linting is the automated analysis of an API description or design against rules for correctness, consistency, security, and maintainability.
Automating API Delivery
An API linter is a tool that evaluates API definitions against configurable rules and reports violations.
- How it is used
- Checks API definitions against style-guide rules during design and continuous integration.
- How deep it goes
- Explains ruleset inputs, Spectral rules and overrides, and a pipeline step; leaves detailed API design outside its scope.
- Examples
- Uses Spectral CLI output, targeted rule overrides, a GitHub Actions pull-request job, and HTTPS and sensitive-field warnings.
- What you can do after
- Apply it via Spectral to check definitions locally and in a pull-request pipeline, adjusting rules and severities to organizational policy.
The Design of Web APIs, Second Edition
API linting is the automated analysis of an API description or design for violations of quality, consistency, security, and maintainability rules.
- How it is used
- Automates API design guidelines while checking API definitions for design and authoring problems.
- How deep it goes
- Develops rule construction through JSONPath selectors and Spectral functions, but leaves judgments about consumer needs to designers.
- Examples
- Uses property casing, missing pagination parameters, undefined security scopes, and duplicated path parameters as detectable problems.
- What you can do after
- Apply it via Spectral to check and tailor guidelines, locate problems, and prevent avoidable breaking changes.
Read how The Design of Web APIs, Second Edition explains api linting →
Also covered in
What to know first
- api governanceAPI governance is the organizational practice of establishing, coordinating, and enforcing policies, standards, and controls for API development, management, and security.
- deployment pipelineA deployment pipeline is a repeatable sequence of stages that builds, tests or validates, packages, and delivers software changes toward release or deployment.
- OpenAPI specificationThe OpenAPI Specification is a machine-readable standard for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
- contractA contract is an agreed specification of the conditions, expectations, rights, or obligations that govern behavior or interactions between parties or software components.
Related concepts
- OpenAPI specificationuses · The OpenAPI Specification is a machine-readable standard for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
- api styleconfigured by · An API style guide is a documented set of conventions for designing, naming, documenting, securing, and evolving APIs.
- consistencypart of · Consistency is the degree to which related data, behavior, or results agree with one another and conform to applicable rules or expectations.
- review processalternative to · A review process is a structured evaluation of work, performance, artifacts, or proposals against relevant criteria to assess quality, progress, correctness, or suitability.
- guidelineimplements · A guideline is a recommendation or principle that directs how an activity is performed or decisions are made, without necessarily imposing an absolute requirement.
- language modelused by · A language model is a computational model that represents patterns in linguistic sequences to assign probabilities, predict, generate, or evaluate language.
Questions about api linting
What is api linting?
API linting is the automated analysis of an API description or design against rules for correctness, consistency, security, and maintainability.
Which Manning books explain api linting?
Automating API Delivery and The Design of Web APIs, Second Edition.
What should I know before learning api linting?
Manning books that teach api linting usually introduce api governance, deployment pipeline, OpenAPI specification and contract first.
What is the difference between api linting and review process?
API linting is the automated analysis of an API description or design against rules for correctness, consistency, security, and maintainability. A review process is a structured evaluation of work, performance, artifacts, or proposals against relevant criteria to assess quality, progress, correctness, or suitability.
What is api linting part of?
Api linting is part of consistency. Consistency is the degree to which related data, behavior, or results agree with one another and conform to applicable rules or expectations.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.

