Swagger Docs

yin-zt · Sep 12, 2023 · 2c9f50c · 2c9f50c
1 parent b227772
commit 2c9f50c
Show file tree

Hide file tree

Showing 11 changed files with 2,909 additions and 1,691 deletions.
diff --git a/Makefile b/Makefile
@@ -18,4 +18,8 @@ tork:
 .PHONY: clean
 clean:
 	go clean
-	rm -f tork
+	rm -f tork
+
+.PHONY: generate-swagger
+generate-swagger: 
+	 swag init  --parseDependency -g internal/coordinator/api/api.go --output docs/swagger
diff --git a/README.md b/README.md
@@ -147,11 +147,19 @@ Check out the [examples](examples/) folder.
 
 See the [REST API](https://www.tork.run/rest) documentation.
 
-## Web UI
+### Swagger Docs
+
+Start Tork in `standalone` or `coordinator` mode.
+
+```shell
+go run cmd/main.go run standalone
+```
+
+Visit [http://localhost:8000/swagger](http://localhost:8000/swagger)
 
-[Tork Web](https://github.com/runabol/tork-web) is a web based tool for interacting with Tork.
+## Web UI
 
-!["Tork Web"](docs/tork-web-v2.png)
+[Tork Web](https://www.tork.run/web-ui) is a web based tool for interacting with Tork.
 
 ## License