feat: add support for path-prefix

some APIs add prefixes to all paths, rather than 
embedding them into the server URL.

This provides a configuration to work around that.

Author: toumorokoshi

cmd/aepcli/main.go

@@ -41,9 +41,11 @@ func aepcli() error {
 	}
 
 	var rawHeaders []string
+	var pathPrefix string
 	rootCmd.Flags().SetInterspersed(false) // allow sub parsers to parse subsequent flags after the resource
 	rootCmd.PersistentFlags().StringArrayVar(&rawHeaders, "header", []string{}, "Specify headers in the format key=value")
 	rootCmd.PersistentFlags().StringVar(&logLevel, "log-level", "info", "Set the logging level (debug, info, warn, error)")
+	rootCmd.PersistentFlags().StringVar(&pathPrefix, "path-prefix", "", "Specify a path prefix that is prepended to all paths in the openapi schema. This will strip them when evaluating the resource hierarchy paths.")
 	rootCmd.MarkPersistentFlagRequired("host")
 
 	if err := rootCmd.Execute(); err != nil {
@@ -67,6 +69,9 @@ func aepcli() error {
 			os.Exit(1)
 		}
 		fileOrAlias = filepath.Join(cd, api.OpenAPIPath)
+		if api.PathPrefix == "" {
+			pathPrefix = api.PathPrefix
+		}
 		rawHeaders = append(rawHeaders, api.Headers...)
 	}
 
@@ -75,7 +80,7 @@ func aepcli() error {
 		fmt.Println(err)
 		os.Exit(1)
 	}
-	serviceDefinition, err := service.GetServiceDefinition(openapi)
+	serviceDefinition, err := service.GetServiceDefinition(openapi, pathPrefix)
 	if err != nil {
 		fmt.Println(err)
 		os.Exit(1)
@@ -91,8 +96,7 @@ func aepcli() error {
 
 	result, err := s.ExecuteCommand(resource, additionalArgs)
 	if err != nil {
-		fmt.Println("an error occurred: %v", err)
-		os.Exit(1)
+		return err
 	}
 	fmt.Println(result)
 	return nil

internal/config/config.go

@@ -16,6 +16,7 @@ type API struct {
 	Name        string
 	OpenAPIPath string
 	Headers     []string
+	PathPrefix  string
 }
 
 // ReadConfig reads the configuration from the default configuration file.

internal/service/service_definition.go

@@ -15,11 +15,12 @@ type ServiceDefinition struct {
 	Resources map[string]*Resource
 }
 
-func GetServiceDefinition2(api *openapi.OpenAPI) (*ServiceDefinition, error) {
+func GetServiceDefinition(api *openapi.OpenAPI, pathPrefix string) (*ServiceDefinition, error) {
 	resourceBySingular := make(map[string]*Resource)
 	// we try to parse the paths to find possible resources, since
 	// they may not always be annotated as such.
 	for path, pathItem := range api.Paths {
+		path = strings.TrimPrefix(path, pathPrefix)
 		var r Resource
 		var sRef *openapi.Schema
 		p := getPatternInfo(path)
@@ -103,7 +104,7 @@ func GetServiceDefinition2(api *openapi.OpenAPI) (*ServiceDefinition, error) {
 	// get the first serverURL url
 	serverURL := ""
 	for _, s := range api.Servers {
-		serverURL = s.URL
+		serverURL = s.URL + pathPrefix
 	}
 	if serverURL == "" {
 		return nil, errors.New("no servers found in the OpenAPI definition. Cannot find a server to send a request to")
@@ -115,31 +116,6 @@ func GetServiceDefinition2(api *openapi.OpenAPI) (*ServiceDefinition, error) {
 	}, nil
 }
 
-func GetServiceDefinition(api *openapi.OpenAPI) (*ServiceDefinition, error) {
-	resources := make(map[string]*Resource)
-	for name, s := range api.Components.Schemas {
-		if s.XAEPResource != nil {
-			_, err := addResourceToMap(s, resources, api)
-			if err != nil {
-				return nil, fmt.Errorf("error adding resource %q to map: %v", name, err)
-			}
-		}
-	}
-	// get the first serverURL url
-	serverURL := ""
-	for _, s := range api.Servers {
-		serverURL = s.URL
-	}
-	if serverURL == "" {
-		return nil, errors.New("no servers found in the OpenAPI definition. Cannot find a server to send a request to")
-	}
-
-	return &ServiceDefinition{
-		ServerURL: serverURL,
-		Resources: resources,
-	}, nil
-}
-
 func (s *ServiceDefinition) GetResource(resource string) (*Resource, error) {
 	r, ok := (*s).Resources[resource]
 	if !ok {
@@ -148,42 +124,6 @@ func (s *ServiceDefinition) GetResource(resource string) (*Resource, error) {
 	return r, nil
 }
 
-func addResourceToMap(s openapi.Schema, resourceMap map[string]*Resource, api *openapi.OpenAPI) (*Resource, error) {
-	r := s.XAEPResource
-	if r == nil {
-		return nil, fmt.Errorf("schema does not have the x-aep-resource annotation")
-	}
-	singular := strings.ToLower(r.Singular)
-	if r, ok := resourceMap[singular]; ok {
-		return r, nil
-	}
-	parents := []*Resource{}
-	for _, p := range r.Parents {
-		s, ok := api.Components.Schemas[p]
-		if !ok {
-			return nil, fmt.Errorf("resource %q parent %q not found", r.Singular, p)
-		}
-		parentResource, err := addResourceToMap(s, resourceMap, api)
-		if err != nil {
-			return nil, fmt.Errorf("error parsing resource %q parent %q: %v", r.Singular, p, err)
-		}
-		parents = append(parents, parentResource)
-	}
-
-	resource := Resource{
-		Singular: r.Singular,
-		Plural:   r.Plural,
-		Parents:  parents,
-		Pattern:  strings.Split(r.Patterns[0], "/")[1:],
-		Schema:   &s,
-	}
-	if existingResource, found := resourceMap[strings.ToLower(r.Plural)]; found {
-		foldResourceMethods(existingResource, &resource)
-	}
-	resourceMap[singular] = &resource
-	return &resource, nil
-}
-
 type PatternInfo struct {
 	// if true, the pattern represents an individual resource,
 	// otherwise it represents a path to a collection of resources

internal/service/service_definition_test.go

@@ -182,7 +182,7 @@ func TestGetServiceDefinition2(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			result, err := GetServiceDefinition2(tt.api)
+			result, err := GetServiceDefinition(tt.api)
 
 			if tt.expectedError != "" {
 				assert.Error(t, err)