v2.0.0: doc: add swagger from code

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
GnomeZworc 2024-03-17 21:54:48 +01:00
commit ee4e2e3e31
Signed by: nicolas.boufideline
GPG key ID: 4406BBBF8845D632
8 changed files with 502 additions and 3 deletions

View file

@ -6,19 +6,35 @@ import (
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
echoSwagger "github.com/swaggo/echo-swagger"
"gitlab.g3e.fr/h6n/users/lib"
"database/sql"
_ "github.com/lib/pq"
_ "gitlab.g3e.fr/h6n/users/cmd/docs"
)
var db *sql.DB = nil
// Logout
// @Tags auth
// @Description Cette route permet de revoker sont token
// @Product json
// @Router / [delete]
// @Success 200 {object} string
// @Security ApiKeyAuth
func logout(c echo.Context) error {
return c.NoContent(http.StatusNoContent)
}
// Logout
// @Tags auth
// @Description Cette route de verifier que le token est toujours valide
// @Product json
// @Router / [get]
// @Success 200 {object} string
// @Security ApiKeyAuth
func isLoggedIn(c echo.Context) error {
return c.NoContent(http.StatusNoContent)
}
@ -45,6 +61,9 @@ func skip_auth(c echo.Context) bool {
if c.Request().Method == "GET" && c.Path() == "/health" {
return true
}
if len(c.Path()) > 9 && c.Path()[:9] == "/swagger/" {
return true
}
return false
}
@ -55,6 +74,21 @@ func skip_log(c echo.Context) bool {
return false
}
// @title Users
// @version 1.0
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name Authorization
// @description Enter the token with the `Bearer: ` prefix, e.g. "Bearer abcde12345".
func main() {
init_database()
if err := lib.InitLoginBiscuit(); err != nil {
@ -76,6 +110,7 @@ func main() {
e.POST("/", login)
e.DELETE("/", logout)
e.GET("/health", health)
e.GET("/swagger/*", echoSwagger.WrapHandler)
// Start server
e.Logger.Fatal(e.Start(":1222"))