Implement swagger
This commit is contained in:
@@ -1,3 +1,11 @@
|
||||
# music-index
|
||||
|
||||
Music collection software for indexing bought (physical) albums. Build with Golang and Postgres
|
||||
Music collection software for indexing bought (physical) albums. Build with Golang and Postgres
|
||||
|
||||
## Swagger
|
||||
The API documentation is available at `/swagger/index.html` after running the application. It provides details about the available endpoints, request/response formats, and other relevant information for developers to interact with the API effectively.
|
||||
|
||||
Regenerate the docs with the following command in the /api/ folder:
|
||||
```
|
||||
$ go run github.com/swaggo/swag/cmd/swag@v1.16.4 init -g main.go -o docs
|
||||
```
|
||||
Reference in New Issue
Block a user