liveBook · Manning

Api lifecycle

As explained in Automating API Delivery

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

An API can reach production yet still be difficult to discover, poorly documented, or unreliable. Treating an API as a product gives its team a shared lifecycle for planning, building, governing, and operating what consumers use. The lifecycle begins with an idea and can extend to sunset; organizations may define its stages differently. section 1.0 section 1.3

One practical model has five high-level stages:

  • Plan and design: capture ideas and requirements, create a conceptual domain model, and review API definitions with prospective users. section 1.3
  • Build: implement, unit-test, and package backend microservices; mock the API so consumers can develop in parallel. section 1.3
  • Deploy and test: configure the API gateway and deploy to a nonproduction environment for acceptance testing. section 1.3
  • Publish: put documentation and release notes in a developer portal. section 1.3
  • Operate: run the API in production and monitor its functional health, performance, and security. section 1.3

APIOps applies DevOps and GitOps principles across this lifecycle. Store API definitions and configuration in Git, then use automated validation and deployment in a CI/CD workflow. API linting and breaking-change checks can support design governance; Git-controlled configuration deployments can improve release reliability and auditability. Automation supports consistent checks, while review with prospective users remains part of design. section 1.0 section 1.3 section 1.9

Security across stages

A security platform may scan API definitions during design, dynamically test the API in nonproduction, and monitor production traffic for threats. These are different checks at different lifecycle stages, not a single pre-release security gate. section 10.2.14

Use the five stages to place responsibilities and governance controls, not as an exhaustive delivery procedure. In particular, the model names sunset as part of an API product’s existence but does not prescribe a retirement process. section 1.3

How Automating API Delivery covers it

How deep it goes
Defines five high-level stages and their activities, but does not prescribe low-level delivery procedures or a sunset process.
Examples
Uses API definitions, consumer review, gateway deployment, developer-portal publication, and security checks at design, test, and runtime.
What it assumes
Assumes a RESTful API-product and microservice context while defining the lifecycle stages without requiring a low-level delivery procedure.
What you can do after
Apply it via Git-controlled API definitions and configuration to organize validation and deployment across API delivery.
How it connects
Connects API products with APIOps, DevOps, GitOps, CI/CD, design governance, and API security.

Also explained in

Compare how 2 books explain api lifecycle →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.