We’ve added these worksheets to accompany our hands-on design advice. The worksheets can be used to accompany the fictitious example from Chapter 5, or used repeatedly as templates for your own API designs.
Briefly define the problem and how it affects customers and the business.
Define what success looks like for your API. What will the world be like after you’ve released your new API?
List several key user stories for your API with the following template:
Describe the technology architecture you’ve selected, along with the reasons behind your decision. You may wish to include charts or graphs showing the pros and cons of paradigms you’ve considered. Here’s an optional example table:
|Pattern, paradigm, or protocol considered||Pros||Cons||Selected?|
Give a high-level description of the implementation plan. You may wish to use additional tables or diagrams to describe your plan.
Describe how developers will gain access to the API.
If you considered any other API paradigms, architectures, authentication strategies, protocols, etc., briefly mention what you considered. ...