Voltaserve API
Getting Started
Install swag and golangci-lint.
Run for development:
go run .
Build binary:
go build .
Build Docker image:
docker build -t voltaserve/api .
Run code linter:
golangci-lint run
Generate and Publish Documentation
Format swag comments:
swag fmt
Generate swagger.yml:
swag init --output ./docs --outputTypes yaml
Preview (will be served at http://127.0.0.1:5555):
npx @redocly/cli preview-docs --port 5555 ./docs/swagger.yaml
Generate the final static HTML documentation:
npx @redocly/cli build-docs ./docs/swagger.yaml --output ./docs/index.html