-
Notifications
You must be signed in to change notification settings - Fork 53
[Info] How to update Swagger annotations in CB Tumblebug
Seokho Son edited this page Oct 21, 2024
·
2 revisions
[Download Swag for Go] (Do only once) (FYI: Swag converts Go annotations to Swagger Documentation 2.0.)
$ go get github.com/swaggo/swag/cmd/swag
[Add ~/go/bin
to your $PATH
]
Add lines like these in your .bashrc
or .zshrc
:
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
[Convert Go annotations to Swagger Documentation 2.0]
In cb-tumblebug/
, run the following commend:
make swag
→ These files will be updated:
cb-tumblebug/src/docs/docs.go
cb-tumblebug/src/docs/swagger.json
cb-tumblebug/src/docs/swagger.yaml
[Build CB-Tumblebug binary]
Run make && make run
and test.
- Design
- Features & Usage
- Install & Start Guide
- User Interface
- Developer Guide
- Test Reports