Swagger, WADL or similar for the REST API?

[fantasticfears (Erick Guan)]

@erkist

I know @fantasticfears has an embryo of a Swagger definition on Github, which he posted about here: https://meta.discourse.org/t/a-community-effort-to-improve-discourses-documentation/29129/18 but as far as I can see it only describes which calls are available, not what they return. I’d like to generate a complete strongly typed library.

I didn’t improve the Swagger definition since then. But the team maintains a discourse_api gem which is the so called client.

Use the Discourse API ruby gem

So you want to use Discourse API? Great! Let’s get started. Set up Discourse development environment Set up Discourse development environment using our Windows, OS X or Ubuntu guide. Clone Discourse API Gem Now that you have set up Discourse development environment, you should already have Git and Ruby installed on your system. You can install Discourse API gem by running following command from console: git clone https://github.com/discourse/discourse_api.git ~/discourse_api Install dep…

Discourse REST API Documentation

Discourse API Please view the Discourse API Documentation site for detailed info: https://docs.discourse.org Deprecation Warning! On April 6th, 2020 we dropped support for all non-HTTP header based authentication (excluding some rss, mail-receiver, and ics routes). This means that API requests that have an api_key and api_username in the query params or in the HTTP body of the request will soon stop working. Please see the example cURL request below for how to update your API requ…