liveBook · Manning

Api naming

API naming is the practice of assigning identifiers that communicate an API element's purpose and distinguish it from others.

How 2 Manning books explain it

API Design Patterns

An API name is a user-visible identifier assigned to an API element such as a function, method, resource, or field.

How it is used
Guides naming decisions for public API elements whose identifiers users depend on across source code and integrations.
How deep it goes
Explains naming qualities, context, conventions, units, and custom-method syntax, while stopping short of implementation mechanics.
Examples
Uses rocket-launching paths, verb-noun RPC names, preposition pitfalls, units, and richer data types as concrete naming cases.
What you can do after
Evaluate and choose API names that communicate intent, fit established conventions, avoid ambiguity, and resist costly changes.

Read how API Design Patterns explains api naming →

The Design of Web APIs, Second Edition

An API name is the identifying label that communicates an API's subject matter, business concept, use case, or offered capabilities.

How it is used
Guides API discovery, comprehension, boundary-setting, and long-term evolution for consumers choosing among available APIs.
How deep it goes
Explains naming criteria, timing, trade-offs, and concrete alternatives, but does not detail a naming syntax or formal naming standard.
Examples
Compares “API,” “Web Service,” “New Banking Architecture,” “Banking,” “Account,” and “Online Money Transfer.”
What you can do after
Apply API naming by selecting a durable, capability-focused label after clarifying user needs and API granularity.

Read how The Design of Web APIs, Second Edition explains api naming →

What to know first

Related concepts

Questions about api naming

What is api naming?

API naming is the practice of assigning identifiers that communicate an API element's purpose and distinguish it from others.

Which Manning books explain api naming?

API Design Patterns and The Design of Web APIs, Second Edition.

What should I know before learning api naming?

Manning books that teach api naming usually introduce HTTP GET, HTTP method and contract first.

What is api naming part of?

Api naming is part of contract. A contract is an agreed specification of the conditions, expectations, rights, or obligations that govern behavior or interactions between parties or software components.

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.