2.1 API Artefacts

There are some fundamental artefacts which comprise an API deliverable:

  • Interface specification, accessible via some form of catalogue
  • API code and policies
  • Unit tests
  • Service Level Agreement (SLA) for the API, identifying performance, availability etc.

These artefacts are the responsibility of the API developer and should be mandated as a minimum set of deliverables when developing an API. All of these artefacts must be managed in a software configuration management system (SCM) so that changes can be tracked and collaborative development can be performed.

Page last updated: 16/12/2016