Good APIs Project

Include good error logging, so that when errors happen, the calls are all logged and you will be able to diagnose what went wrong.

“Fix your bugs in public “

If possible, get other development teams/projects using your API early to get wider feedback than just the local development team. Engage with your API users and encourage community feedback. Provide a clear and robust contact mechanism for queries regarding the API. Ideally this should be the name of an individual who could potentially leave the organisation. Provide a way for users of the API to sign up to a mailing list to receive prior notice of any changes.

“An API will need to evolve over time in response to the needs of the people attempting to use it, especially if the primary users of the API were not well defined to begin with. “