Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
self_data_technical_doc
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
web-et-numerique
Factory
LLLE_Project
self_data_technical_doc
Commits
ae6d6dda
Commit
ae6d6dda
authored
10 months ago
by
Bastien DUMONT
Browse files
Options
Downloads
Patches
Plain Diff
docs: remove swagger for backoffice
parent
198b26e3
No related branches found
No related tags found
1 merge request
!74
docs: remove swagger for backoffice
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/ecolyo-agent/Technical/libraries.md
+2
-6
2 additions, 6 deletions
docs/ecolyo-agent/Technical/libraries.md
docs/ecolyo-agent/Technical/swagger_documentation.md
+0
-14
0 additions, 14 deletions
docs/ecolyo-agent/Technical/swagger_documentation.md
with
2 additions
and
20 deletions
docs/ecolyo-agent/Technical/libraries.md
+
2
−
6
View file @
ae6d6dda
...
...
@@ -19,7 +19,7 @@ It allows to send HTTP request and manage the responses.
## Lodash
j
ava
s
cript utility library
J
ava
S
cript 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
...
...
This diff is collapsed.
Click to expand it.
docs/ecolyo-agent/Technical/swagger_documentation.md
deleted
100644 → 0
+
0
−
14
View file @
198b26e3
# 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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment