I am proposing the Discourse API documentation using RESTful API Modeling Language (RAML) . This would enable us to: programmatically interact with the API perform testing on various endpoints automatically generated interactive interfaces to read the documentation maintain the API docs along with …

Great idea :wink: The API Docs are currently being re-written in YAML which ReDoc uses to display the results.

Discourse API Documentation Using RAML

Topic		Replies	Views
Programmatic way to get all API endpoints for my instance? Development rest-api	11	537	April 24, 2025
Why isn't the Discourse API fully documented? Development	9	2206	January 13, 2020
Swagger, WADL or similar for the REST API? Development	10	14710	August 30, 2016
Discourse API Documentation Released! Blog	2	4095	March 8, 2017
Contributing to the Discourse API documentation Contributing rest-api , how-to	4	3239	April 2, 2024