search

RocketChat / feature-requests

This repository is used to track Rocket.Chat feature requests and discussions. Click here to open a new feature request.
21 stars 9 forks source link

Self-documenting REST API #766

Open doctorwho92 opened 7 years ago

doctorwho92 commented 7 years ago

Your Rocket.Chat version: (0.41.0)

I would like to see a self-documenting REST API, preferably based around Swagger/OAI.

The API documentation should include stubs for planned but not implemented endpoints, so people can see what the roadmap is.

rodrigok commented 5 years ago

@MarcosSpessatto any news about the swagger implementation via GSoC?

MarcosSpessatto commented 5 years ago

The implementation of GSoC is not 100% ready, basically the playground interface is ready, but there are some aspects to be reviewed, such as the completion of converting all endpoints to the OpenAPI spec, because in GSoC project we could not complete all. After that, we need to see how we will fetch these specs files from the main repository, as they are several files and maybe via HTTP calls is not the best way. If you'd like to check that: https://rodriq.github.io/GSoC-2019-Interactive-APIs-Docs/developer-guides/rest-api/miscellaneous/spotlight/

avonar commented 2 years ago

any news about swagger/raml/redoc/etc ?

Frontrider commented 1 year ago

Openapi is the one to go with at this point. Adopted as an industry standard in way too many places.