API Lifecycle

This document describes common ideas and stages related to API Lifecycle Management.

See also: APIOps

Lifecycle Stages

Design

In design stage, the API Owner and Developer consider the overall structure of the API. What information will be accessible? What access control will be provided? The design process also includes initial documentation, in standard formats.

  • Tasks and deliverables

    • API description
    • API diagram
    • API business case
    • Stakeholder communication plan

  • Tools and Resources

    • A Product Managers Guide to Cloud Integrations

    Designing a Great Web API

    API Design Tools List

    Develop

    The development stage involves programming or extending software platforms to provide access to the application data. This can be done in any platform, programming language, etc., and is dependent on existing infrastructure. The development process also includes revising of design documentation, to match the constraints of development.

  • Tasks and deliverables

    • API specification document in machine format (e.g. RAML)
    • API documentation file (e.g. Swagger)
    • Custom software development

    Deploy

    Deployment inolves making the API accessible to the general public. This often falls under the jurisprudence of API Ops professionals, who manage the infrastructure to ensure functionality, uptime, etc.

  • Tasks and deliverables

    • API load balancer configuration
    • Proxy deployment and configuration
    • Analytics configuration (e.g. reporting)

    Revision

    As new business and customer needs emerge, or as the data takes shape, it is often necessary to change the original design. This can be done in such a way that minimises disruption to existing customers, such as API versioning, deprecation notices, and backwards compatibility.

  • Tasks and deliverables

    • User needs assessment
    • Data service audit
    • API revision planning
    • User notification

    Retire

    Once the API has served its functional lifespan, it is time for it to be retired. This includes issuing retirement notices to existing customers, re-purposing infrastructure, and planning new business strategy.

  • Tasks and deliverables

    • Business model document
    • Stakeholder communication document

    References

    IBM Phases

    • Preview
    • Beta
    • Live