LemmyNet/lemmy-docs
2
0
Fork 0
mirror of https://github.com/LemmyNet/lemmy-docs.git synced 2025-02-02 23:11:35 +00:00
Code Issues Projects Releases Wiki Activity

Adding multiple api docs. (#342)

Browse source 
* Adding multiple api docs.

* Removing pointless header.
This commit is contained in:
Dessalines 2025-01-24 10:25:50 -05:00 committed by GitHub
parent 6230839e45
commit 2d68d738c7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/contributors/04-api.md
View file

@ -1,12 +1,19 @@
# API
Lemmy has an HTTP API for clients and frontends. See the [API documentation](/api) for more information. Instead of using the API directly you can use one of the existing [libraries](https://github.com/dbeley/awesome-lemmy#libraries). You can either interact with a local development instance via `http://localhost:8536`, or connect to a production instance. The following instances are available for testing purposes:
Lemmy has `OpenAPI` and javascript client docs, for app and client developers.
| Version | OpenAPI | lemmy-js-client |
| ------------- | --------------------- | ---------------------------------------- |
| release/v0.19 | [OpenAPI](/api/v0.19) | [JS-client](/lemmy-js-client-docs/v0.19) |
| main / dev | [OpenAPI](/api/main) | [JS-client](/lemmy-js-client-docs/main) |
Instead of using the API directly you can use one of the existing [libraries](https://github.com/dbeley/awesome-lemmy#libraries). You can either interact with a local development instance via `http://localhost:8536`, or connect to a production instance. The following instances are available for testing purposes:
- https://enterprise.lemmy.ml/
- https://ds9.lemmy.ml/
- https://voyager.lemmy.ml/
More clearly arranged, unofficial API documentation is available at:
Other unofficial API documentation is available at:
- [lemmy.readme.io](https://lemmy.readme.io/)
- [mv-gh.github.io/lemmy_openapi_spec](https://mv-gh.github.io/lemmy_openapi_spec/)