Version Control API

API Strategy

Guidelines

• All APIs should adhere to standard REST conventions
• Error codes should be chosen as detailed as possible following rfc-7231 section 6
  • No non-getter response code returned by the application should end in 00
  • Codes should always be considered from the part of the application.
    • 4XX series codes relate to data received from a client
    • 5XX series codes relate to how the data was processed and internal issues
  • HATEOS conventions should be employed when able
• All GET endpoints should return one of the following
  • Descriptions of what the endpoint does along with documentation links and related resources links
  • A collection of items
  • A single item
• All responses should be in application/json format
• API versioning must included in the URI

Swagger Documentation

In order to make the API usable, each endpoint requires documentation. The Swagger 2.0 API standard is employed for this use.