Notes on the Assets Checklist

Design and Build Great Web APIs — by Mike Amundsen (125 / 127)

👈 Using the API Project Assets Checklist | TOC | Your API Project Assets Checklist 👉

As a rule, each asset should be something you can create in less than a day. If your API is extensive (dozens of actions), you can break the API into smaller subsections and produce assets for each subset. For example, the API Definition document and API Test collection may take several days to complete, but it should not take more than a workweek. If that seems unlikely, break the definition and tests into smaller collections and complete those as needed.

You’ll notice that each asset in the list that follows is marked with MUST, SHOULD, and MAY references as well as brief notes about formats and recommendations. These reflect my common experience, and YMMV (your mileage may vary). Feel free to modify the recommendations to fit your working experience, needs, and company culture.

Finally, you’ll find pointers to other sections in the book that discuss the particular asset and/or recommendation in greater detail. Over time, you may find additional external references to add to your customized checklist too. When authoring your API project assets checklist, it’s a good idea to include reference articles, tool documentation, blogs, and other forms of background information. This helps people see the thinking behind the recommendations and encourages others to seek out and amend the references over time.

👈 Using the API Project Assets Checklist | TOC | Your API Project Assets Checklist 👉

Design and Build Great Web APIs by Mike Amundsen can be purchased in other book formats directly from the Pragmatic Programmers. If you notice a code error or formatting mistake, please let us know here so that we can fix it.