mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-07-04 13:06:09 +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>
107 lines
3.4 KiB
Go
107 lines
3.4 KiB
Go
// Copyright 2022 Woodpecker Authors
|
|
// Copyright 2021 Informatyka Boguslawski sp. z o.o. sp.k., http://www.ib.pl/
|
|
// 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.
|
|
//
|
|
// This file has been modified by Informatyka Boguslawski sp. z o.o. sp.k.
|
|
|
|
package api
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/rs/zerolog/log"
|
|
|
|
"github.com/woodpecker-ci/woodpecker/server"
|
|
"github.com/woodpecker-ci/woodpecker/server/badges"
|
|
"github.com/woodpecker-ci/woodpecker/server/ccmenu"
|
|
"github.com/woodpecker-ci/woodpecker/server/model"
|
|
"github.com/woodpecker-ci/woodpecker/server/store"
|
|
"github.com/woodpecker-ci/woodpecker/server/store/types"
|
|
)
|
|
|
|
// GetBadge
|
|
//
|
|
// @Summary Get status badge, SVG format
|
|
// @Router /badges/{owner}/{name}/status.svg [get]
|
|
// @Produce image/svg+xml
|
|
// @Success 200
|
|
// @Tags Badges
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
func GetBadge(c *gin.Context) {
|
|
_store := store.FromContext(c)
|
|
repo, err := _store.GetRepoName(c.Param("owner") + "/" + c.Param("name"))
|
|
if err != nil || !repo.IsActive {
|
|
if err == nil || errors.Is(err, types.RecordNotExist) {
|
|
c.AbortWithStatus(http.StatusNotFound)
|
|
return
|
|
}
|
|
_ = c.AbortWithError(http.StatusInternalServerError, err)
|
|
return
|
|
}
|
|
|
|
// if no commit was found then display
|
|
// the 'none' badge, instead of throwing
|
|
// an error response
|
|
branch := c.Query("branch")
|
|
if len(branch) == 0 {
|
|
branch = repo.Branch
|
|
}
|
|
|
|
pipeline, err := _store.GetPipelineLast(repo, branch)
|
|
if err != nil {
|
|
log.Warn().Err(err).Msg("")
|
|
pipeline = nil
|
|
}
|
|
|
|
// we serve an SVG, so set content type appropriately.
|
|
c.Writer.Header().Set("Content-Type", "image/svg+xml")
|
|
c.String(http.StatusOK, badges.Generate(pipeline))
|
|
}
|
|
|
|
// GetCC
|
|
//
|
|
// @Summary Provide pipeline status information to the CCMenu tool
|
|
// @Description CCMenu displays the pipeline status of projects on a CI server as an item in the Mac's menu bar.
|
|
// @Description More details on how to install, you can find at http://ccmenu.org/
|
|
// @Description The response format adheres to CCTray v1 Specification, https://cctray.org/v1/
|
|
// @Router /badges/{owner}/{name}/cc.xml [get]
|
|
// @Produce xml
|
|
// @Success 200
|
|
// @Tags Badges
|
|
// @Param owner path string true "the repository owner's name"
|
|
// @Param name path string true "the repository name"
|
|
func GetCC(c *gin.Context) {
|
|
_store := store.FromContext(c)
|
|
repo, err := _store.GetRepoName(c.Param("owner") + "/" + c.Param("name"))
|
|
if err != nil {
|
|
handleDbGetError(c, err)
|
|
return
|
|
}
|
|
|
|
pipelines, err := _store.GetPipelineList(repo, &model.ListOptions{Page: 1, PerPage: 1})
|
|
if err != nil || len(pipelines) == 0 {
|
|
c.AbortWithStatus(http.StatusNotFound)
|
|
return
|
|
}
|
|
|
|
url := fmt.Sprintf("%s/%s/%d", server.Config.Server.Host, repo.FullName, pipelines[0].Number)
|
|
cc := ccmenu.New(repo, pipelines[0], url)
|
|
c.XML(http.StatusOK, cc)
|
|
}
|