Api lifecycle

As explained in The Design of Web APIs, Second Edition

An API lifecycle is the sequence of activities through which an API progresses from identifying a need to development, testing, deployment, and later operation or evolution.

An API lifecycle tracks an API from identifying a need through design, development, testing, deployment, and consumption. It separates API design from deciding to create an API and from coding its implementation. section 1.3.3

Figure 1.7 API design is an iterative activity distinct from deciding to create an API and implementing it.

Use the lifecycle figure to see why API work is iterative rather than a strict sequence: activities can overlap, repeat, and send discoveries back to earlier decisions. section 1.3.3

A typical lifecycle includes these activities:

• Define the need, such as monetizing platform content or supporting friend identification in images and videos. section 1.3.3
• Design capabilities and interfaces, describe them, and enrich the resulting artifacts. section 1.6
• Develop, test, deploy, and provide the API for consumption, often using a gateway, catalog, or developer portal. section 1.3.3

Design reference kit

An API Capabilities Canvas, OpenAPI document, design guidelines, linting rules, simulated API, or functional tests can guide implementation, testing, deployment, and consumer use. section 19.0

How The Design of Web APIs, Second Edition covers it

How deep it goes

Explains lifecycle stages and iteration, while deferring detailed implementation code, architecture, tests, and deployment concerns.

Examples

Uses a monetized Search API, an image-based friend-identification microservice, and an API design reference kit.

What it assumes

Assumes a need or requirement exists, while distinguishing that need from API design and implementation.

What you can do after

Evaluate API work by locating needs, design decisions, delivery activities, feedback loops, and supporting artifacts within the lifecycle.

How it connects

Connects API design with API development, API gateways, API catalogs, developer portals, OpenAPI, and JSON Schema.

liveBookmanning.com

Read The Design of Web APIs, Second Edition on liveBook Get the book at manning.com

Also explained in

• 

  liveBookmanning.com
  Automating API DeliveryAn API life cycle is the sequence of stages through which an API is designed, developed, tested, deployed, operated, improved, and retired.

Compare how 2 books explain api lifecycle →

Related concepts

• deprecationhas part · Deprecation is the designation of a software feature, interface, component, version, or model as discouraged or no longer recommended while it remains available and may later be withdrawn.
• contracthas part · An API contract is a specification of the operations, data, and behavioral expectations that govern interactions between software components.
• API testinghas part · API testing is the systematic evaluation of an application programming interface by sending requests and verifying responses, behavior, data handling, and security against specified expectations.
• APIOpsproduced by · APIOps is the practice of automating the governance, delivery, and operation of API products across their life cycle.
• OpenAPI specificationused by · The OpenAPI Specification is a standard, machine-readable format for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.

This explainer was generated by Manning's knowledge graph from the text of The Design of Web APIs, Second Edition. The section links point to the parts of the book it draws on.