index.html.md.erb

---
title: API Documentation
last_reviewed_on: 2023-08-16
review_in: 12 months
weight: 100
---

# API Documentation

All teams building APIs should be automatically publishing their documentation using the
[OpenAPI Specification 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md).
Teams should use [these instructions](https://github.com/hmcts/cnp-api-docs#publish-swagger-docs)
for publishing the swagger spec file to the [central api docs repository](https://github.com/hmcts/cnp-api-docs).

It's expected that all APIs follow our [API standards](/cloud-native-platform/standards/apis.html#api-design).

A network map of microservice dependencies can be generated using this central repository by manually
committing some additional information about the new service.

See the [README](https://github.com/hmcts/cnp-api-docs/blob/master/README.md)
for information on how to do this.

<a rel="noopener" target="_blank" title="API Docs" href="https://hmcts.github.io/cnp-api-docs">
    <img src="/images/api-docs-preview.png"/>
</a>
<a rel="noopener" target="_blank" title="API Docs" href="https://hmcts.github.io/cnp-api-docs">
    View API documentation
</a>