Design and Build Great Web APIs

Your API Project Assets Checklist

The following is the general assets list I use to start an API project.

1. API story document: MUST
   • See ​Writing the API Story​
   • Recommend using an approved template/pattern for stories
   • As a —– I want to —– so that —–
   • Purpose, Data, Actions, Rules, Processes

     • Recommend collecting supporting documents (forms, write-ups, wireframes, and so on)

     • If available, include output from event-storming or other sessions

2. API diagram: MUST
   • See ​Creating Your Sequence Diagram​
   • Recommend WSD format
   • Sequence diagrams suggested, but any consistent method accepted
3. API vocabulary list: SHOULD

   • See ​Identifying Your API Descriptors​

   • Include a complete list of all properties and actions used in the life of the API

   • Recommend tying these directly ...