Api style
An API style guide is a documented set of conventions for designing, naming, documenting, securing, and evolving APIs.
Automating API Delivery
An API style guide is a documented set of conventions that teams must follow when designing APIs.
- How it is used
- Standardizes API design across teams and supplies the rules for design-stage governance checks.
- How deep it goes
- Defines typical conventions and traces their enforcement through linting and review, while leaving organization-specific guide creation to adaptation.
- Examples
- Uses URI naming, OAuth2 authentication, error-response fields, public REST guidelines, and Google’s API Improvement Proposals as examples.
- What you can do after
- Apply it via Spectral rulesets and review to check API definitions, interpret findings, and refine guidance.
Microservices Patterns, Second Edition
An API style guide is an organization-wide set of conventions for designing, naming, documenting, securing, and evolving APIs.
- How it is used
- Establishes shared conventions so independently developed services remain predictable and easier to integrate.
- How deep it goes
- Lists REST convention areas and describes Service Chassis enforcement without prescribing a complete set of rules.
- Examples
- Uses a Java backend and AngularJS frontend integration failure and points to the Adidas API Guidelines.
- What you can do after
- Evaluate shared API conventions and identify decisions a REST style guide should address.
Read how Microservices Patterns, Second Edition explains api style →
What to know first
- GraphQLGraphQL is a query language and execution specification for APIs that lets clients request and manipulate data through a schema.
- OpenAPI specificationThe OpenAPI Specification is a machine-readable standard for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
- rest apiA REST API is an application programming interface that exposes resources through representations and provides interactions according to the constraints of the REST architectural style.
Related concepts
- api lintingconfigures · API linting is the automated analysis of an API description or design against rules for correctness, consistency, security, and maintainability.
- linter rulehas part · A linter rule is a condition or constraint that a linter checks against code or another structured artifact to detect or report patterns or violations.
- api governancepart of · API governance is the organizational practice of establishing, coordinating, and enforcing policies, standards, and controls for API development, management, and security.
- API design patternused by · An API design pattern is a reusable solution to a recurring problem in designing an API's interface or interactions.
- api standardkind of · An API standard is a documented specification defining required interface behavior and compliance expectations for API implementations.
Questions about api style
What is api style?
An API style guide is a documented set of conventions for designing, naming, documenting, securing, and evolving APIs.
Which Manning books explain api style?
Automating API Delivery and Microservices Patterns, Second Edition.
What should I know before learning api style?
Manning books that teach api style usually introduce GraphQL, OpenAPI specification and rest api first.
What kinds of api style are there?
Kinds of api style include Zalando RESTful API and Event Guidelines.
What is api style a kind of?
Api style is a kind of api standard. An API standard is a documented specification defining required interface behavior and compliance expectations for API implementations.
What is api style part of?
Api style is part of api governance. API governance is the organizational practice of establishing, coordinating, and enforcing policies, standards, and controls for API development, management, and security.
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.

