Ensuring the goals behind an API are well defined and accessible as part of the operation of an API help ground a team's activity when it comes to supporting consumers and iterating upon API, helping ensure that the API design and operation is in alignment with business objectives.

Does this provide what you need? Let us know by submitting issue!

Having goals for each API helps articulate the value an API should be delivering in plain language. Goals can be as simple as a paragraph narrative or a bulleted list. Goals should help a team better understand what the business value for an API will be, and help keep the technical details of an API more precise when it comes to design and development, as well as iteration with each version. Keeping goals an active part of each version of an API, and making sure they are published as part of documentation, and within reach of the team within a workspace helps make sure APIs are as coherent as possible in their evolution.


Return to Main Page

This provides a link back to the home page if you need it.