A Well Defined API Lifecycle

featured-image

We wanted to invest in API governance at Union Fashion, but as soon as we began defining what we were going to measure we realized that we couldn’t measure we wasn’t defined. To help us be able to measure, track, discuss, and improve on how we deliver APIs at Union Fashion we need to map out how we were going to be delivering APIs from start to finish.

  • Define (Docs) - Providing guidelines for how APIs should be defined.
  • Design (Docs) - Training and guidance about how to design APIs.
  • Mocking (Docs) - The ability to mock an API to assist in it's delivery.
  • Documentation (Docs) - Always having consistent up to date documentation.
  • Database (NoSQL) (Docs) - Ensuring there is always persistent data storage.
  • Database (SQL) (Docs) - Ensuring there is always persistent data storage.
  • Storage (Docs) - Providing a place to put objects as part of API operations.
  • Compute (Docs) - Having the appropriate amount of compute behind each API.
  • Pipeline (Docs) - Making the delivery of code behind each API repeatable.
  • Deployment (Docs) - Making sure that APIs are deployed in repeatable ways.
  • Management (Docs) - Ensuring that every API is being managed consistently.
  • Logging (Docs) - Establishing a centralized logging strategy across APIs.
  • Encryption (Docs) - Always making encryption the default response across APIs.
  • DNS (Docs) - Having a strategy for how DNS is handled across groups and APIs.
  • Portal (Docs) - Ensuring there is always a doorway to get at all APIs.
  • Testing (Docs) - Providing a consistent approach to testing all APIs.
  • Security (Docs) - Scanning and auditing the security landscape for each API.
  • Monitoring (Docs) - Having monitors on a schedule ensuring the quality of APIs.
  • Support (Docs) - Requiring there be support for every API being operated.
  • Communications (Docs) - Having consistent communication in place for APIs.
  • Analytics (Docs) - Establishing a layer for understanding what is happening.
  • Deprecation (Docs) - Making sure there is a plan for how all APIs will be sunset.

This API lifecycle will continue to change and evolve over time. I twill probably posses a couple of forks in the road, but each of these areas have been define as a problem area for the company, and something we wanted to improve upon. You can follow each of the links above to the documentation for the API lifecycle collection showing one possible way APIs will be delivered from end to end here at Union Fashion.