Skip to content
Snippets Groups Projects
Commit ae6d6dda authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

docs: remove swagger for backoffice

parent 198b26e3
No related branches found
No related tags found
1 merge request!74docs: remove swagger for backoffice
......@@ -19,7 +19,7 @@ It allows to send HTTP request and manage the responses.
## Lodash
javascript utility library
JavaScript utility library
Lodash modular method are great for:
......@@ -40,16 +40,12 @@ CSS Preprocessor
It allows us to easily manage large CSS files and split across different files.
It allows us to create variables, nested rules, mixins, functions, and do mathematical calculations.
## Gorilla/Mux
## Chi
Package for Go that implements a request router and dispatcher for matching incoming requests to their respective handler.
It allows us to easily create and manage routes/APIs
## Swag
Package for Go that converts annotations to Swagger Documentation 2.0.
## Gorm
ORM for Go
......
# Swagger documentation
The different routes exposed by the backend are described by Swagger documentation in local env. The documentation is NOT exposed in REC or PROD.
Once the client is deployed, the documentation is accessible at https://localhost/doc/
To build Swagger documentation :
- Make sure you installed swag by running : `go install github.com/swaggo/swag/cmd/swag@latest`
:::tip
If "command not found: swag" or "No such file or directory", run `export PATH=$PATH:$(go env GOPATH)/bin`
:::
- go to server repository and run `./scripts/init-swagger-doc.sh`
This will update `docs/swagger.json` and `docs/swagger.yaml` based on the annotations written above exposed methods.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment