Jaycean commented on a change in pull request #1245: URL: https://github.com/apache/apisix-dashboard/pull/1245#discussion_r564215393
########## File path: api/internal/handler/data_loader/route_export.go ########## @@ -0,0 +1,441 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 data_loader + +import ( + "context" + "encoding/json" + "fmt" + "net/http" + "reflect" + "strings" + + "github.com/apisix/manager-api/internal/core/entity" + "github.com/apisix/manager-api/internal/core/store" + "github.com/apisix/manager-api/internal/handler" + "github.com/apisix/manager-api/internal/log" + "github.com/apisix/manager-api/internal/utils" + "github.com/getkin/kin-openapi/openapi3" + "github.com/gin-gonic/gin" + "github.com/shiningrush/droplet" + "github.com/shiningrush/droplet/data" + "github.com/shiningrush/droplet/wrapper" + wgin "github.com/shiningrush/droplet/wrapper/gin" +) + +type Handler struct { + routeStore store.Interface + upstreamStore store.Interface + serviceStore store.Interface + consumerStore store.Interface +} + +func NewHandler() (handler.RouteRegister, error) { + return &Handler{ + routeStore: store.GetStore(store.HubKeyRoute), + upstreamStore: store.GetStore(store.HubKeyUpstream), + serviceStore: store.GetStore(store.HubKeyService), + consumerStore: store.GetStore(store.HubKeyConsumer), + }, nil +} + +func (h *Handler) ApplyRoute(r *gin.Engine) { + r.POST("/apisix/admin/routes/export/:ids", wgin.Wraps(h.ExportRoutes, + wrapper.InputType(reflect.TypeOf(ExportInput{})))) + r.GET("/apisix/admin/exportall/routes", wgin.Wraps(h.ExportAllRoutes)) +} + +type ExportInput struct { + IDs string `auto_read:"ids,path"` +} + +func (h *Handler) ExportRoutes(c droplet.Context) (interface{}, error) { + input := c.Input().(*ExportInput) + ids := strings.Split(input.IDs, ",") + routes := []*entity.Route{} + + for _, id := range ids { + route, err := h.routeStore.Get(context.Background(), id) + if err != nil { + return nil, err + } + routes = append(routes, route.(*entity.Route)) + } + + swagger, err := h.routeToOpenApi3(routes) + if err != nil { + return nil, err + } + return swagger, nil +} + +type AuthType string + +const ( + BasicAuth AuthType = "basic-auth" + KeyAuth AuthType = "key-auth" + JWTAuth AuthType = "jwt-auth" +) + +var ( + openApi = "3.0.0" + title = "RoutesExport" + service interface{} + err error +) + +func (h *Handler) ExportAllRoutes(c droplet.Context) (interface{}, error) { + routelist, err := h.routeStore.List(c.Context(), store.ListInput{}) + + if err != nil { + return nil, err + } + + routes := []*entity.Route{} + + for _, route := range routelist.Rows { + routes = append(routes, route.(*entity.Route)) + } + + swagger, err := h.routeToOpenApi3(routes) + if err != nil { + return nil, err + } + return swagger, nil +} + +func (h *Handler) routeToOpenApi3(routes []*entity.Route) (*openapi3.Swagger, error) { + paths := openapi3.Paths{} + paramsRefs := []*openapi3.ParameterRef{} + requestBody := &openapi3.RequestBody{} + components := &openapi3.Components{} + secSchemas := openapi3.SecuritySchemes{} + servicePlugins := make(map[string]interface{}) + plugins := make(map[string]interface{}) + serviceLabels := make(map[string]string) + labels := make(map[string]string) + + for _, route := range routes { + extensions := make(map[string]interface{}) + pathItem := &openapi3.PathItem{} + path := openapi3.Operation{} + path.Summary = route.Desc + path.OperationID = route.Name + + if route.ServiceID != nil { + serviceID := utils.InterfaceToString(route.ServiceID) + service, err = h.serviceStore.Get(context.Background(), serviceID) + if err != nil { + if err == data.ErrNotFound { + return nil, fmt.Errorf("service id: %s not found", route.ServiceID) + } + return nil, err + } + + _service := service.(*entity.Service) + servicePlugins = _service.Plugins + serviceLabels = _service.Labels + } + + if route.Upstream != nil { + extensions["x-apisix-upstream"] = route.Upstream + } else if route.UpstreamID != nil && route.Upstream == nil { + upstreamID := utils.InterfaceToString(route.UpstreamID) + upstream, err := h.upstreamStore.Get(context.Background(), upstreamID) + if err != nil { + if err == data.ErrNotFound { + return nil, fmt.Errorf("upstream id: %s not found", route.UpstreamID) + } + return nil, err + } + extensions["x-apisix-upstream"] = upstream + } else if route.UpstreamID == nil && route.Upstream == nil && route.ServiceID != nil { + _service := service.(*entity.Service) + if _service.Upstream != nil { + extensions["x-apisix-upstream"] = _service.Upstream + } else if _service.Upstream == nil && _service.UpstreamID != nil { + upstreamID := utils.InterfaceToString(_service.UpstreamID) + upstream, err := h.upstreamStore.Get(context.Background(), upstreamID) + if err != nil { + if err == data.ErrNotFound { + return nil, fmt.Errorf("upstream id: %s not found", _service.UpstreamID) + } + return nil, err + } + extensions["x-apisix-upstream"] = upstream + } + } + + if route.Host != "" { + extensions["x-apisix-host"] = route.Host + } + + if route.Hosts != nil { + extensions["x-apisix-hosts"] = route.Hosts + } + + //Parse Labels + labels, err = parseLabels(route, serviceLabels, labels) + if err != nil { + log.Errorf("parseLabels err: ", err) + return nil, err + } + + if labels != nil { + extensions["x-apisix-labels"] = labels + } + + if route.RemoteAddr != "" { + extensions["x-apisix-remote_addr"] = route.RemoteAddr + } + + if route.RemoteAddrs != nil { + extensions["x-apisix-remote_addrs"] = route.RemoteAddrs + } + + if route.FilterFunc != "" { + extensions["x-apisix-filter_func"] = route.FilterFunc + } + + if route.Script != nil { + extensions["x-apisix-script"] = route.Script + } + + if route.ServiceProtocol != "" { + extensions["x-apisix-service_protocol"] = route.ServiceProtocol + } + if route.Vars != nil { + extensions["x-apisix-vars"] = route.Vars + } + + // analysis route.URIs + routeURIs := []string{} + if route.URI != "" { + routeURIs = append(routeURIs, route.URI) + } + + if route.Uris != nil { + routeURIs = route.Uris + } + + for _, uri := range routeURIs { + if strings.Contains(uri, "*") { + paths[strings.Split(uri, "*")[0]+"{params}"] = pathItem + // add params introduce + paramsRefs = append(paramsRefs, &openapi3.ParameterRef{ + Value: &openapi3.Parameter{ + In: "path", + Name: "params", + Required: true, + Description: "params in path", + Schema: &openapi3.SchemaRef{Value: &openapi3.Schema{Type: "string"}}}}) + } else { + paths[uri] = pathItem + } + } + + //Parse Route Plugins + path, secSchemas, paramsRefs, plugins, err = parseRoutePlugins(route, paramsRefs, plugins, path, servicePlugins, secSchemas, requestBody) + if err != nil { + log.Errorf("parseRoutePlugins err: ", err) + return nil, err + } + if plugins != nil { + extensions["x-apisix-plugins"] = plugins + } + + extensions["x-apisix-priority"] = route.Priority + extensions["x-apisix-status"] = route.Status + extensions["x-apisix-enable_websocket"] = route.EnableWebsocket + path.Extensions = extensions + path.Parameters = paramsRefs + path.RequestBody = &openapi3.RequestBodyRef{Value: requestBody} + path.Responses = openapi3.NewResponses() + + for i := range route.Methods { + switch strings.ToUpper(route.Methods[i]) { + case http.MethodGet: + //pathItem.Get = path + pathItem.Get = parsePathItem(path, http.MethodGet) + case http.MethodPost: + //pathItem.Post = path + pathItem.Post = parsePathItem(path, http.MethodPost) + case http.MethodPut: + //pathItem.Put = path + pathItem.Put = parsePathItem(path, http.MethodPut) + case http.MethodDelete: + //pathItem.Delete = path + pathItem.Delete = parsePathItem(path, http.MethodDelete) + case http.MethodPatch: + //pathItem.Patch = path + pathItem.Patch = parsePathItem(path, http.MethodPatch) + case http.MethodHead: + //pathItem.Head = path + pathItem.Head = parsePathItem(path, http.MethodHead) + } + } + } + + components.SecuritySchemes = secSchemas + swagger := openapi3.Swagger{ + OpenAPI: openApi, + Info: &openapi3.Info{Title: title, Version: openApi}, + Paths: paths, + Components: *components, + } + return &swagger, nil +} + +func parseLabels(route *entity.Route, serviceLabels map[string]string, labels map[string]string) (map[string]string, error) { Review comment: I don't quite understand your question. Do you mean you don't see users or business scenarios using this field? I don't know if my understanding is correct, because more coverage possibilities are considered everywhere to ensure that the data is not lost. After discussing with nic-chen, this processing function is added. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
