mirrors/gotosocial
1
0
Fork 1
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-05-19 00:38:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
gotosocial/docs/api/swagger.md
Tobi Smethurst 58dddd86e0
Swagger (#124) 
* start experimenting with swagger documentation

* further adventures in swagger

* do a few more api paths

* account paths documented

* go fmt

* fix up some models

* bit o lintin'
2021-07-31 17:49:59 +02:00

710 B
Raw Blame History

API Documentation

GoToSocial uses go-swagger to generate a V2 OpenAPI specification document from code annotations.

The resulting API documentation is rendered below, for quick reference.

If you'd like to do more with the spec, you can also view the swagger.yaml directly, and then paste it into something like the Swagger Editor in order to autogenerate GoToSocial API clients in different languages, convert the doc to JSON or OpenAPI v3 specification, etc. See here for more.

!!swagger swagger.yaml!!