infureal/gis
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Second checkpoint

Browse Source
This commit is contained in:
Bakhtiyar Issakhmetov
2026-06-25 01:19:59 +05:00
parent 9cf791b789
commit ddbf41dbeb
5 changed files with 745 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -25,7 +25,7 @@ migrations/ embedded goose SQL migrations
configs/ .env.example
deployments/ docker-compose (postgres, minio, rabbitmq)
build/package/ Dockerfile
docs/ generated OpenAPI/Swagger spec (swaggo/swag)
api/openapi.yaml OpenAPI 3.1.1 spec (embedded + served at /openapi.yaml)
```
## Domain
@@ -105,14 +105,10 @@ Health: `GET /healthz` (liveness), `GET /readyz` (DB + S3 + RabbitMQ).
### HTTP API
The API is documented with [swaggo/swag](https://github.com/swaggo/swag)
annotations on the handlers. The generated spec lives in `docs/` and is served
as interactive **Swagger UI** at `/swagger/index.html` while the server runs.
Regenerate after changing annotations:
```sh
make docs # go tool swag init -g cmd/gis/main.go --parseInternal --output docs
```
The API is described by an **OpenAPI 3.1.1** spec at
[`api/openapi.yaml`](api/openapi.yaml), embedded into the binary. While the
server runs it is served at `/openapi.yaml`, with an interactive **Redoc** UI at
`/docs`.
| Method | Path | Description |
|--------|----------------------------|--------------------------------------|