mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-25 18:06:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 25

openapi: add documentation, small optimisation

Browse source
This commit is contained in:
Viljami Kuosmanen 2020-03-29 20:25:43 +02:00 • committed by muxator
parent c2cca39c7d
commit e821bbcad8
5 changed files with 154 additions and 180 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/api/http_api.md
View file

@ -11,6 +11,10 @@ The API is designed in a way, so you can reuse your existing user system with th
Take a look at [HTTP API client libraries](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) to check if a library in your favorite programming language is available.
### OpenAPI
OpenAPI (formerly swagger) definitions are exposed under `/api/openapi.json` (latest) and `/api/{version}/openapi.json`. You can use official tools like [Swagger Editor](https://editor.swagger.io/) to view and explore them.
## Examples
### Example 1