gotosocial/docs/api/swagger.md

# API Documentation

GoToSocial uses [go-swagger](https://github.com/go-swagger/go-swagger) to generate a V2 [OpenAPI specification](https://swagger.io/specification/v2/) 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](./swagger.yaml) directly, and then paste it into something like the [Swagger Editor](https://editor.swagger.io/) in order to autogenerate GoToSocial API clients in different languages, convert the doc to JSON or OpenAPI v3 specification, etc. See [here](https://swagger.io/tools/open-source/getting-started/) for more.

<swagger-ui src="swagger.yaml"/>
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			`# API Documentation`

			`GoToSocial uses [go-swagger](https://github.com/go-swagger/go-swagger) to generate a V2 [OpenAPI specification](https://swagger.io/specification/v2/) document from code annotations.`

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

[docs/bugfix] fix link to swagger yaml (#2333) 2023-11-04 16:48:13 +01:00			`If you'd like to do more with the spec, you can also view the [swagger.yaml](./swagger.yaml) directly, and then paste it into something like the [Swagger Editor](https://editor.swagger.io/) in order to autogenerate GoToSocial API clients in different languages, convert the doc to JSON or OpenAPI v3 specification, etc. See [here](https://swagger.io/tools/open-source/getting-started/) for more.`
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
[feature] Use Material theme for docs (#1535) * [feature] Use Material theme for docs This changes the theme to use Material with the slate (dark) theme and the accent colour set to orange. It also replaces the swagger plugin with one that works correctly with the Material theming. * Add theme by @f0x52 Co-authored-by: f0x52 <f0x@cthu.lu> * Enable social cards The dependencies for cairosvg and pillow can be satisfied on RTD, so this adds them to our requirements.txt and enables the social plugin. This generates opengraph and twitter card tags as well as fancy preview images in GTS colour style for platforms that show that as part of link previews. * Update Conda environment.yml * update theme for swagger, basic light theme option * dark mode mobile header bg color --------- Co-authored-by: f0x52 <f0x@cthu.lu> 2023-02-20 23:09:17 +01:00			`<swagger-ui src="swagger.yaml"/>`