tsk-35: Add API documentation (#39)

Closes #35 Reviewed-on: phoenix/textsender-api#39 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>
2025-11-13 21:45:17 +00:00
parent 0cd71c5506
commit f69d56f527
14 changed files with 2597 additions and 23 deletions
@@ -8,3 +8,14 @@ A software system to process Text messaging queueing
 ```BASH
 make build
 ```
+
+
+Generate API documentation
+```
+go install github.com/swaggo/swag/cmd/swag@latest
+go get -u github.com/swaggo/http-swagger/v2
+
+swag init --generalInfo main.go --dir ./cmd/api,./internal/handler --output docs/ --parseDependency --parseInternal
+```
+
+The API documentation can be viewed from `http://localhost:8080/swagger/index.html`.