README
¶
TopDrawerSoccer API
Setup
echo-swagger
In order to get started we need to first install the command line tool.
go get -u github.com/swaggo/swag/cmd/swag
Then I needed to initialize the root like so
swag init -g cmd/server/main.go
This generate the following files in the docs directory:
- docs/docs.go
- docs/swagger.json
- docs/swagger.yaml
Before I did this I was getting a 500 error while the swagger UI tried to access doc.json.
I've created this repo with the following directories under the pkg directory.
- handlers (contains the http handlers)
- models (contains the data models)
- services (contains the business logic)
References
Documentation
¶
Overview ¶
Copyright © 2023 Omar Crosby <omar.crosby@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories