Skip to main content

API Backlog

A tasks list & knowledge base for delivering API softwares

This backlog works as a cheat sheet for the API community.

It can be usefull to all roles involved in API projects needing an overview on possible tasks to fulfill on API projects.

🚧🏗 Work in progress :-)

ARCHITECT​

Tasks:

  • Analyse software requirements and extract the architectural characteristics
  • Select an architecture style / pattern to answer the requirements
  • Define the system components
  • Write architecture decision for technical solution
  • Present the system components

DESIGN​

Tasks:

  • Capture all information to design the API
  • Select an API style & specification
  • Design api components, interfaces, objects and app logic

BUILD​

Tasks

  • Define the tech stack solution for each API component
  • Generate & validate the code
  • Code exploration, prototype / MVP release, iteration

TEST​

Tasks

  • Define levels of testing & scenarios
  • Create & automate the test
  • Adapt log design

MANAGE TRAFFIC​

Tasks

  • Define traffic management middlewares
  • Choose traffic management solution

DOCUMENT​

Tasks

  • Create, maintain & evolve the documentation
  • Create documentation artefacts adapted to each type of user