From 58dddd86e0ddbb0c6aa54506dcef162321babfbb Mon Sep 17 00:00:00 2001
From: Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>
Date: Sat, 31 Jul 2021 17:49:59 +0200
Subject: 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'
---
 docs/api/swagger.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 docs/api/swagger.md

(limited to 'docs/api/swagger.md')

diff --git a/docs/api/swagger.md b/docs/api/swagger.md
new file mode 100644
index 000000000..50191f18d
--- /dev/null
+++ b/docs/api/swagger.md
@@ -0,0 +1,9 @@
+# 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](/api/swagger/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 swagger.yaml!!
-- 
cgit v1.3