phoenixandphoenix
f69d56f527
Closes #35 Reviewed-on: phoenix/textsender-api#39 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>
22 lines
463 B
Markdown
22 lines
463 B
Markdown
# TextSender-API
|
|
A software system to process Text messaging queueing
|
|
|
|
|
|
## Getting started
|
|
|
|
### Building
|
|
```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`.
|