APIs

API Design and implementation

Use the HMCTS RESTful API standards.

Versioning

Use content type negotiation or endpoint naming to version the API.

Do not make backward incompatible changes to existing endpoints.

See the official guidance in the TGL

Documentation

Use OpenAPI for API documentation.

Maintain a central repository of API documentation.

This page was last reviewed on 25 January 2024. It needs to be reviewed again on 25 January 2025 by the page owner platops-build-notices .

This page was set to be reviewed before 25 January 2025 by the page owner platops-build-notices. This might mean the content is out of date.