kubevela/references/apiserver/route.go

/*
Copyright 2021 The KubeVela Authors.

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 apiserver

import (
	"fmt"
	"net/http"
	"os"

	swaggerFiles "github.com/swaggo/files"
	ginSwagger "github.com/swaggo/gin-swagger"

	"github.com/gin-contrib/static"
	"github.com/gin-gonic/gin"

	// swagger json data
	_ "github.com/oam-dev/kubevela/references/apiserver/docs"
	"github.com/oam-dev/kubevela/references/apiserver/util"
)

// setupRoute sets gin http server handler
// @title KubeVela Restful API
// @description An KubeVela API.
// @version 0.0.1
// @description KubeVela OpenAPI for applications/workloads/operating
// @contact.name Slack #kubevela
// @contact.url https://kubevela.io
// @contact.email NA
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host 127.0.0.1:38081
// @BasePath /api
func (s *APIServer) setupRoute(staticPath string) http.Handler {
	// if deploying static Dashboard, set the mode to `release`, or to `debug`
	if staticPath != "" {
		gin.SetMode(gin.ReleaseMode)
	}
	// create the router
	router := gin.New()
	loggerConfig := gin.LoggerConfig{
		Output: os.Stdout,
		Formatter: func(param gin.LogFormatterParams) string {
			return fmt.Sprintf("%v | %3d | %13v | %15s | %-7s %s | %s\n",
				param.TimeStamp.Format("2006/01/02 - 15:04:05"),
				param.StatusCode,
				param.Latency,
				param.ClientIP,
				param.Method,
				param.Path,
				param.ErrorMessage,
			)
		},
	}

	if staticPath != "" {
		router.Use(static.Serve("/", static.LocalFile(staticPath, false)))
	}

	router.Use(gin.LoggerWithConfig(loggerConfig))
	router.Use(util.SetRequestID())
	router.Use(util.SetContext())
	router.Use(gin.Recovery())
	router.Use(util.ValidateHeaders())
	// all requests start with /api
	api := router.Group(util.RootPath)
	// env related operation
	envs := api.Group(util.EnvironmentPath)
	{
		envs.POST("/", s.CreateEnv)
		envs.PUT("/:envName", s.UpdateEnv)
		envs.GET("/:envName", s.GetEnv)
		envs.GET("/", s.ListEnv)
		// Allow levaing out `/` to make API more friendly
		envs.GET("", s.ListEnv)
		envs.DELETE("/:envName", s.DeleteEnv)
		envs.PATCH("/:envName", s.SetEnv)
		// app related operation
		apps := envs.Group("/:envName/apps")
		{
			apps.GET("/:appName", s.GetApp)
			apps.PUT("/:appName", s.UpdateApps)
			apps.GET("/", s.ListApps)
			apps.GET("", s.ListApps)
			apps.DELETE("/:appName", s.DeleteApps)
			apps.POST("/", s.CreateApplication)

			// component related operation
			components := apps.Group("/:appName/components")
			{
				components.GET("/:compName", s.GetComponent)
				components.PUT("/:compName", s.GetComponent)
				components.GET("/", s.GetApp)
				components.GET("", s.GetApp)
				components.DELETE("/:compName", s.DeleteComponent)

				traitWorkload := components.Group("/:compName/" + util.TraitDefinitionPath)
				{
					traitWorkload.POST("/", s.AttachTrait)
					traitWorkload.DELETE("/:traitName", s.DetachTrait)
				}
			}
		}
	}
	// component related api
	workload := api.Group(util.ComponentDefinitionPath)
	{
		workload.GET("/:componentName", s.GetWorkload)
		workload.PUT("/:componentName", s.UpdateWorkload)
		workload.GET("/", s.ListWorkload)
		workload.GET("", s.ListWorkload)
	}
	// trait related api
	trait := api.Group(util.TraitDefinitionPath)
	{
		trait.GET("/:traitName", s.GetTrait)
		trait.GET("/", s.ListTrait)
		trait.GET("", s.ListTrait)
	}
	// scope related api
	scopes := api.Group(util.ScopeDefinitionPath)
	{
		scopes.POST("/", s.CreateScope)
		scopes.GET("/:scopeName", s.GetScope)
		scopes.PUT("/:scopeName", s.UpdateScope)
		scopes.GET("/", s.ListScope)
		scopes.GET("", s.ListScope)
		scopes.DELETE("/:scopeName", s.DeleteScope)
	}

	// capability center related api
	capCenters := api.Group(util.CapabilityCenterPath)
	{
		capCenters.PUT("/", s.AddCapabilityCenter)
		capCenters.GET("/", s.ListCapabilityCenters)
		capCenters.GET("", s.ListCapabilityCenters)
		capCenters.DELETE("/:capabilityCenterName", s.DeleteCapabilityCenter)

		caps := capCenters.Group("/:capabilityCenterName" + util.CapabilityPath)
		{
			caps.PUT("/", s.SyncCapabilityCenter)
			caps.PUT("/:capabilityName", s.AddCapabilityIntoCluster)
		}
	}

	// capability related api
	caps := api.Group(util.CapabilityPath)
	{
		caps.DELETE("/:capabilityName", s.RemoveCapabilityFromCluster)
		caps.DELETE("/", s.RemoveCapabilityFromCluster)
		caps.GET("/", s.ListCapabilities)
		caps.GET("", s.ListCapabilities)
	}

	// Definition related api
	defs := api.Group(util.Definition)
	{
		defs.GET("/:name", s.GetDefinition)
	}

	// version
	api.GET(util.VersionPath, s.GetVersion)

	// swagger
	swaggers := router.Group("/swagger")
	{
		url := ginSwagger.URL("/swagger/swagger.json")
		swaggers.GET("/*any", s.SwaggerJSON, ginSwagger.WrapHandler(swaggerFiles.Handler, url))
	}

	// default
	router.NoRoute(util.NoRoute())

	return router
}