# New Swagger REST API Docs Live!

**URL:** <https://forum.communityhealthtoolkit.org/t/new-swagger-rest-api-docs-live/5570>\
**Category:** Documentation\
**Created:** [April 16, 2026, 7:02pm UTC](https://forum.communityhealthtoolkit.org/t/new-swagger-rest-api-docs-live/5570 "2026-04-16T19:02:25Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![jkuester](https://communityhealthtoolkit.b-cdn.net/user_avatar/forum.communityhealthtoolkit.org/jkuester/32/806_2.png) [@jkuester](https://forum.communityhealthtoolkit.org/u/jkuester)\
**Post date:** [April 16, 2026, 7:02pm UTC](https://forum.communityhealthtoolkit.org/t/new-swagger-rest-api-docs-live/5570/1 "2026-04-16T19:02:25Z")

</div>

The new “Swagger” UI for our docs for the CHT REST api is now [live on the docs site](https://docs.communityhealthtoolkit.org/building/reference/api/)!

 ![image](https://communityhealthtoolkit.b-cdn.net/uploads/default/original/2X/9/92e322cfe2966b26fc08f44ae3bf8241ac7d80ab.jpeg)

This new documentation format is easier to read/browse thanks to the consistency and features of Swagger. It is also _much_ easier to maintain and keep up-to-date because it is built automatically from configuration tracked in cht-core.

In cht-core we use the [OpenAPI specification](https://swagger.io/specification/) to capture the details of each REST endpoint. We store those details in comments close to the code for the endpoint so it can be easily updated when the code changes. Then, an automated pipeline will publish the updated OpenAPI specification for the CHT endpoints whenever a commit is merged to `master`. The newly published spec is immediately reflected [on the docs page](https://docs.communityhealthtoolkit.org/building/reference/api/) without requiring a separate PR to the cht-docs repo. 👍

See [this documentation page](https://docs.communityhealthtoolkit.org/community/contributing/code/core/openapi-docs/) for more details on the process.
