mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-07-02 12:05:56 +00:00
14177635b6
# Summary This PR drops the outdated former swagger.yaml/json and introduced automatic API document generation from Go code. The generated code is also used to generate documentation/markdown for the community page, as well as enable the Woodpecker server to serve a Swagger Web UI for manual tinkering. I did opt-in for gin-swagger, a middleware for the Gin framework, to ease implementation and have a sophisticated output. This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi 3x tooling is not yet that mature, so I guess that's fine for now. ## Implemenation notes - former swagger.json files removed - former // swagger godocs removed - introduced new dependency gin-swagger, which uses godoc annotations on top of Gin Handler functions. - reworked Makefile to automatically generate Go code for the server - introduce new dependency go-swagger, to generate Markdown for documentation purposes - add a Swagger Web UI, incl. capabilities for manual API exploration - consider relative root paths in the implementation - write documentation for all exposed API endpoints - incl. API docs in the community website (auto-generated) - provide developer documentation, for the Woodpecker authors - no other existing logic/code was intentionally changed --------- close #292 --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: 6543 <6543@obermui.de>
87 lines
2.4 KiB
Go
87 lines
2.4 KiB
Go
// Copyright 2018 Drone.IO Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package router
|
|
|
|
import (
|
|
"net/http"
|
|
"net/url"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/rs/zerolog/log"
|
|
swaggerfiles "github.com/swaggo/files"
|
|
ginSwagger "github.com/swaggo/gin-swagger"
|
|
"github.com/woodpecker-ci/woodpecker/cmd/server/docs"
|
|
"github.com/woodpecker-ci/woodpecker/server"
|
|
|
|
"github.com/woodpecker-ci/woodpecker/server/api"
|
|
"github.com/woodpecker-ci/woodpecker/server/api/metrics"
|
|
"github.com/woodpecker-ci/woodpecker/server/router/middleware/header"
|
|
"github.com/woodpecker-ci/woodpecker/server/router/middleware/session"
|
|
"github.com/woodpecker-ci/woodpecker/server/router/middleware/token"
|
|
"github.com/woodpecker-ci/woodpecker/server/web"
|
|
)
|
|
|
|
// Load loads the router
|
|
func Load(noRouteHandler http.HandlerFunc, middleware ...gin.HandlerFunc) http.Handler {
|
|
e := gin.New()
|
|
e.UseRawPath = true
|
|
e.Use(gin.Recovery())
|
|
|
|
e.Use(func(c *gin.Context) {
|
|
log.Trace().Msgf("[%s] %s", c.Request.Method, c.Request.URL.String())
|
|
c.Next()
|
|
})
|
|
|
|
e.Use(header.NoCache)
|
|
e.Use(header.Options)
|
|
e.Use(header.Secure)
|
|
e.Use(middleware...)
|
|
e.Use(session.SetUser())
|
|
e.Use(token.Refresh)
|
|
|
|
e.NoRoute(gin.WrapF(noRouteHandler))
|
|
|
|
e.GET("/web-config.js", web.Config)
|
|
|
|
e.GET("/logout", api.GetLogout)
|
|
e.GET("/login", api.HandleLogin)
|
|
auth := e.Group("/authorize")
|
|
{
|
|
auth.GET("", api.HandleAuth)
|
|
auth.POST("", api.HandleAuth)
|
|
auth.POST("/token", api.GetLoginToken)
|
|
}
|
|
|
|
e.GET("/metrics", metrics.PromHandler())
|
|
e.GET("/version", api.Version)
|
|
e.GET("/healthz", api.Health)
|
|
|
|
apiRoutes(e)
|
|
setupSwaggerConfigAndRoutes(e)
|
|
|
|
return e
|
|
}
|
|
|
|
func setupSwaggerConfigAndRoutes(e *gin.Engine) {
|
|
docs.SwaggerInfo.Host = getHost(server.Config.Server.Host)
|
|
docs.SwaggerInfo.BasePath = server.Config.Server.RootURL + "/api"
|
|
e.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
|
|
}
|
|
|
|
func getHost(s string) string {
|
|
parse, _ := url.Parse(s)
|
|
return parse.Host
|
|
}
|