Skip to content

feat: add swagger-ui for lake #1900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
warren830 merged 11 commits into from
May 19, 2022
Merged

feat: add swagger-ui for lake #1900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5b680f5
add basic annotation in api.go
xgdyp May 17, 2022
785b9f0
add annotation in task.go
xgdyp May 17, 2022
15b2795
add swagger annotation
xgdyp May 17, 2022
3f2bc40
add swagger annotation in blueprints
xgdyp May 17, 2022
e45d506
add annotation in push.go
xgdyp May 17, 2022
1a77bff
add annotation in pipelines and fix a typo in url
xgdyp May 17, 2022
e79b0ad
change .mod and .sum
xgdyp May 17, 2022
8baee7d
generate docs.go
xgdyp May 17, 2022
d27b024
fix push post param
xgdyp May 19, 2022
4b68c01
change .gitignore
xgdyp May 19, 2022
57c0b93
update annotation:
xgdyp May 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,7 @@ vendor
bin
libgit2
.air.toml

#swagger .json and .yaml
api/docs/swagger.json
api/docs/swagger.yaml
12 changes: 12 additions & 0 deletions api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,28 @@ package api
import (
"time"

_ "github.com/merico-dev/lake/api/docs"

"github.com/gin-contrib/cors"
"github.com/gin-gonic/gin"
"github.com/merico-dev/lake/config"
ginSwagger "github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
)

// @title DevLake Swagger API
// @version 0.1
// @description <h2>This is the main page of devlake api</h2>
// sdfasdfasd
// @license.name Apache-2.0
// @host localhost:8080
// @BasePath /
func CreateApiService() {
v := config.GetConfig()
gin.SetMode(v.GetString("MODE"))
router := gin.Default()

router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
// CORS CONFIG
router.Use(cors.New(cors.Config{
AllowOrigins: []string{"*"},
Expand Down
43 changes: 43 additions & 0 deletions api/blueprints/blueprints.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ import (
"github.com/merico-dev/lake/services"
)

// @Summary post blueprints
// @Description post blueprints
// @Tags Blueprints
// @Accept application/json
// @Param blueprint body string true "json"
// @Success 200 {object} models.Blueprint
// @Failure 400 {string} errcode.Error "Bad Request"
// @Failure 500 {string} errcode.Error "Internel Error"
// @Router /blueprints [post]
func Post(c *gin.Context) {
blueprint := &models.Blueprint{}

Expand All @@ -29,6 +38,14 @@ func Post(c *gin.Context) {
shared.ApiOutputSuccess(c, blueprint, http.StatusCreated)
}

// @Summary get blueprints
// @Description get blueprints
// @Tags Blueprints
// @Accept application/json
// @Success 200 {object} gin.H
// @Failure 400 {string} errcode.Error "Bad Request"
// @Failure 500 {string} errcode.Error "Internel Error"
// @Router /blueprints [get]
func Index(c *gin.Context) {
var query services.BlueprintQuery
err := c.ShouldBindQuery(&query)
Expand All @@ -44,6 +61,15 @@ func Index(c *gin.Context) {
shared.ApiOutputSuccess(c, gin.H{"blueprints": blueprints, "count": count}, http.StatusOK)
}

// @Summary get blueprints
// @Description get blueprints
// @Tags Blueprints
// @Accept application/json
// @Param blueprintId path int true "blueprint id"
// @Success 200 {object} models.Blueprint
// @Failure 400 {string} errcode.Error "Bad Request"
// @Failure 500 {string} errcode.Error "Internel Error"
// @Router /blueprints/{blueprintId} [get]
func Get(c *gin.Context) {
blueprintId := c.Param("blueprintId")
id, err := strconv.ParseUint(blueprintId, 10, 64)
Expand All @@ -59,6 +85,14 @@ func Get(c *gin.Context) {
shared.ApiOutputSuccess(c, blueprint, http.StatusOK)
}

// @Summary delete blueprints
// @Description Delete BluePrints
// @Tags Blueprints
// @Param blueprintId path string true "blueprintId"
// @Success 200
// @Failure 400 {string} errcode.Error "Bad Request"
// @Failure 500 {string} errcode.Error "Internel Error"
// @Router /blueprints/{blueprintId} [delete]
func Delete(c *gin.Context) {
pipelineId := c.Param("blueprintId")
id, err := strconv.ParseUint(pipelineId, 10, 64)
Expand Down Expand Up @@ -97,6 +131,15 @@ func Put(c *gin.Context) {
}
*/

// @Summary patch blueprints
// @Description patch blueprints
// @Tags Blueprints
// @Accept application/json
// @Param blueprintId path string true "blueprintId"
// @Success 200 {object} models.Blueprint
// @Failure 400 {string} errcode.Error "Bad Request"
// @Failure 500 {string} errcode.Error "Internel Error"
// @Router /blueprints/{blueprintId} [Patch]
func Patch(c *gin.Context) {
blueprintId := c.Param("blueprintId")
id, err := strconv.ParseUint(blueprintId, 10, 64)
Expand Down
Loading