phoenixandphoenix
fddf0f7f87
Closes #44 Reviewed-on: phoenix/textsender-api#48 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>
22 lines
421 B
Markdown
22 lines
421 B
Markdown
# TextSender-API
|
|
A software system to process Text messaging queueing
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
### Building
|
|
```SHELL
|
|
make build
|
|
```
|
|
|
|
|
|
Generate API documentation
|
|
```
|
|
go install github.com/swaggo/swag/cmd/swag@latest
|
|
|
|
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`.
|