Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

VersionDescription
1.0Initial published guidance incorporating feedback from SDP Tech Panel
1.1

Updated version incorporating

  • Review feedback from Gartner
  • New guidance on error response formats
  • New guidance on JSON schema usage

RESTful API Design

This page provides guidance on the design of RESTful APIs, refer to API Implementation Considerations for guidance on implementing APIs at CDC.

A service is a logical component that provides functionality to service consumers through an application programming interface (API). APIs decouple the implementation of a service from that service's users by defining a contract between the two, the service implementation can change drastically, e.g. switch the implementation programming language or framework, provided the API remains unchanged.

...