ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2024-11-13 02:17:25 +01:00
Code Issues Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Jan Eitzinger 2022-11-11 10:52:43 +01:00 committed by GitHub
parent c4072ff4c7
commit 126630e01f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -115,7 +115,7 @@ This project integrates [swagger ui](https://swagger.io/tools/swagger-ui/) to do
The swagger doc files can be found in `./api/`. The swagger doc files can be found in `./api/`.
You can generate the configuration of swagger-ui by running `go run github.com/swaggo/swag/cmd/swag init -d ./internal/api,./pkg/schema -g rest.go -o ./api `. You can generate the configuration of swagger-ui by running `go run github.com/swaggo/swag/cmd/swag init -d ./internal/api,./pkg/schema -g rest.go -o ./api `.
You need to move the generated `./api/doc.go` to `./internal/api/doc.go`. You need to move the generated `./api/doc.go` to `./internal/api/doc.go`.
If you start cc-backend with flag `--dev` the Swagger UI is available at http://localhost:8080/swagger . If you start cc-backend with flag `--dev` the Swagger UI is available at http://localhost:8080/swagger/ .
## Project Structure ## Project Structure