feat: Support basePath in options-per-service for openapi generator…

… - Option 2 (#5247) * chore: append basePath to path pattern in openapi generator * chore: switch to using removeSlashes from util * chore: add additional test * chore: check-public-api change * Changes from lint:fix * chore: update test * chore: adjust all tests * chore: fix codeQL warning * Changes from lint:fix * chore: add changeset * chore: cleanup tests * feat: extend openapi request builder for basePath * chore: introduce setBasePath * feat: introduce _defaultBasePath to the generated files * chore: fix order of parameters with intro of basepath * chore: fix tests * chore: add setBasePath * chore: fix failing e2e test * Changes from lint:fix * chore: cleanup path * Changes from lint:fix * chore: adjust test * Changes from lint:fix * chore: switch to using undefined for default basePath value * chore: cleanup test * chore: update changeset * chore: adjust changeset * chore: fix unit test * chore:cleanup * chore: fix test * chore: cleanup changesets * fix: integration test * chore: fix path * chore:fix path * chore: remove dead code * chore: review comment * Update .changeset/chilled-flowers-hide.md Co-authored-by: Deeksha Sinha <[email protected]> * Update packages/openapi/src/openapi-request-builder.ts Co-authored-by: Deeksha Sinha <[email protected]> * chore: address review comments * chore: revert update to removeSlashes utility * Changes from lint:fix * chore: address review comments * chore: tests fix * chore: adjust tests * chore: address review comments * Changes from lint:fix * fix: begin all paths using '/' * chore: address review comments * Update .changeset/chilled-flowers-hide.md Co-authored-by: Deeksha Sinha <[email protected]> * Update .changeset/chilled-flowers-freeze.md Co-authored-by: Deeksha Sinha <[email protected]> * Update packages/util/src/remove-slashes.spec.ts Co-authored-by: Deeksha Sinha <[email protected]> * Update packages/util/src/remove-slashes.spec.ts Co-authored-by: Deeksha Sinha <[email protected]> * chore: address review comments * Changes from lint:fix * chore: add review changes * chore: address review comments * chore:address review comments * chore: address review comments * chore: release note fix --------- Co-authored-by: cloud-sdk-js <[email protected]> Co-authored-by: Junjie Tang <[email protected]> Co-authored-by: Deeksha Sinha <[email protected]>
SAP · Dec 20, 2024 · 1f7b585 · 1f7b585
1 parent 78703e6
commit 1f7b585
Show file tree

Hide file tree

Showing 54 changed files with 561 additions and 215 deletions.
diff --git a/.changeset/chilled-flowers-freeze.md b/.changeset/chilled-flowers-freeze.md
@@ -0,0 +1,5 @@
+---
+'@sap-cloud-sdk/openapi': minor
+---
+
+[New Functionality] Introduce `setBasePath()` method on the OpenAPI request builder, allowing a custom base path URL to be set for a single request. This base path is prepended to the API path parameter for that single request.
diff --git a/.changeset/chilled-flowers-hide.md b/.changeset/chilled-flowers-hide.md
@@ -0,0 +1,7 @@
+---
+'@sap-cloud-sdk/openapi-generator': minor
+'@sap-cloud-sdk/openapi': minor
+'@sap-cloud-sdk/util': minor
+---
+
+[New Functionality] Add `basePath` option in the `options-per-service.json` file in the OpenAPI generator. This option prepends the base URL path to the API path parameter for every request.
diff --git a/.github/actions/check-public-api/index.js b/.github/actions/check-public-api/index.js
diff --git a/packages/openapi-generator/src/file-serializer/__snapshots__/api-file.spec.ts.snap b/packages/openapi-generator/src/file-serializer/__snapshots__/api-file.spec.ts.snap
@@ -8,33 +8,36 @@ import type { QueryParameterType, RefType, ResponseType } from './schema/index.j
  * This API is part of the 'MyServiceName' service.
  */
 export const TestApi = {
+  _defaultBasePath: undefined,
   /**
-   * Create a request builder for execution of get requests to the 'test/{id}' endpoint.
+   * Create a request builder for execution of get requests to the '/test/{id}' endpoint.
    * @param id - Path parameter.
    * @param queryParameters - Object containing the following keys: queryParam.
    * @param headerParameters - Object containing the following keys: headerParam.
    * @returns The request builder, use the \`execute()\` method to trigger the request.
    */
   getFn: (id: string, queryParameters: {'queryParam': QueryParameterType}, headerParameters?: {'headerParam'?: string}) => new OpenApiRequestBuilder<string>(
     'get',
-    "test/{id}",
+    "/test/{id}",
     {
           pathParameters: { id },
           queryParameters,
           headerParameters
-        }
+        },
+    TestApi._defaultBasePath
   ),
   /**
-   * Create a request builder for execution of post requests to the 'test' endpoint.
+   * Create a request builder for execution of post requests to the '/test' endpoint.
    * @param body - Request body.
    * @returns The request builder, use the \`execute()\` method to trigger the request.
    */
   createFn: (body: RefType) => new OpenApiRequestBuilder<ResponseType>(
     'post',
-    "test",
+    "/test",
     {
           body
-        }
+        },
+    TestApi._defaultBasePath
   )
 };"
 `;
@@ -46,13 +49,16 @@ exports[`api-file creates an api file with documentation 1`] = `
  * This API is part of the 'TestService' service.
  */
 export const TestApi = {
+  _defaultBasePath: undefined,
   /**
-   * Create a request builder for execution of get requests to the 'test' endpoint.
+   * Create a request builder for execution of get requests to the '/test' endpoint.
    * @returns The request builder, use the \`execute()\` method to trigger the request.
    */
   getFn: () => new OpenApiRequestBuilder<any>(
     'get',
-    "test"
+    "/test",
+    {},
+    TestApi._defaultBasePath
   )
 };"
 `;
@@ -72,33 +78,78 @@ import type { QueryParameterType, RefType, ResponseType } from './schema';
  * This API is part of the 'MyServiceName' service.
  */
 export const TestApi = {
+  _defaultBasePath: undefined,
   /**
-   * Create a request builder for execution of get requests to the 'test/{id}' endpoint.
+   * Create a request builder for execution of get requests to the '/test/{id}' endpoint.
    * @param id - Path parameter.
    * @param queryParameters - Object containing the following keys: queryParam.
    * @param headerParameters - Object containing the following keys: headerParam.
    * @returns The request builder, use the \`execute()\` method to trigger the request.
    */
   getFn: (id: string, queryParameters: {'queryParam': QueryParameterType}, headerParameters?: {'headerParam'?: string}) => new OpenApiRequestBuilder<string>(
     'get',
-    "test/{id}",
+    "/test/{id}",
     {
           pathParameters: { id },
           queryParameters,
           headerParameters
-        }
+        },
+    TestApi._defaultBasePath
   ),
   /**
-   * Create a request builder for execution of post requests to the 'test' endpoint.
+   * Create a request builder for execution of post requests to the '/test' endpoint.
    * @param body - Request body.
    * @returns The request builder, use the \`execute()\` method to trigger the request.
    */
   createFn: (body: RefType) => new OpenApiRequestBuilder<ResponseType>(
     'post',
-    "test",
+    "/test",
     {
           body
-        }
+        },
+    TestApi._defaultBasePath
+  )
+};"
+`;
+
+exports[`api-file serializes api file with multiple operations and references and base path 1`] = `
+"import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
+import type { QueryParameterType, RefType, ResponseType } from './schema';
+/**
+ * Representation of the 'TestApi'.
+ * This API is part of the 'MyServiceName' service.
+ */
+export const TestApi = {
+  _defaultBasePath: '/base/path/to/service',
+  /**
+   * Create a request builder for execution of get requests to the '/test/{id}' endpoint.
+   * @param id - Path parameter.
+   * @param queryParameters - Object containing the following keys: queryParam.
+   * @param headerParameters - Object containing the following keys: headerParam.
+   * @returns The request builder, use the \`execute()\` method to trigger the request.
+   */
+  getFn: (id: string, queryParameters: {'queryParam': QueryParameterType}, headerParameters?: {'headerParam'?: string}) => new OpenApiRequestBuilder<string>(
+    'get',
+    "/test/{id}",
+    {
+          pathParameters: { id },
+          queryParameters,
+          headerParameters
+        },
+    TestApi._defaultBasePath
+  ),
+  /**
+   * Create a request builder for execution of post requests to the '/test' endpoint.
+   * @param body - Request body.
+   * @returns The request builder, use the \`execute()\` method to trigger the request.
+   */
+  createFn: (body: RefType) => new OpenApiRequestBuilder<ResponseType>(
+    'post',
+    "/test",
+    {
+          body
+        },
+    TestApi._defaultBasePath
   )
 };"
 `;
@@ -110,17 +161,19 @@ exports[`api-file serializes api file with one operation and no references 1`] =
  * This API is part of the 'MyServiceName' service.
  */
 export const TestApi = {
+  _defaultBasePath: undefined,
   /**
-   * Create a request builder for execution of get requests to the 'test/{id}' endpoint.
+   * Create a request builder for execution of get requests to the '/test/{id}' endpoint.
    * @param id - Path parameter.
    * @returns The request builder, use the \`execute()\` method to trigger the request.
    */
   getFn: (id: string) => new OpenApiRequestBuilder<any>(
     'get',
-    "test/{id}",
+    "/test/{id}",
     {
           pathParameters: { id }
-        }
+        },
+    TestApi._defaultBasePath
   )
 };"
 `;
diff --git a/packages/openapi-generator/src/file-serializer/__snapshots__/operation.spec.ts.snap b/packages/openapi-generator/src/file-serializer/__snapshots__/operation.spec.ts.snap
@@ -2,15 +2,16 @@
 
 exports[`serializeOperation serializes operation with path parameters inside () 1`] = `
 "/**
- * Create a request builder for execution of get requests to the 'test('{id}')' endpoint.
+ * Create a request builder for execution of get requests to the '/test('{id}')' endpoint.
  * @param id - Path parameter.
  * @returns The request builder, use the \`execute()\` method to trigger the request.
  */
 getFn: (id: string) => new OpenApiRequestBuilder<Record<string, any>>(
   'get',
-  "test('{id}')",
+  "/test('{id}')",
   {
         pathParameters: { id }
-      }
+      },
+  TestApi._defaultBasePath
 )"
 `;
diff --git a/packages/openapi-generator/src/file-serializer/api-file.spec.ts b/packages/openapi-generator/src/file-serializer/api-file.spec.ts
@@ -23,7 +23,7 @@ const singleOperationApi: OpenApiApi = {
       headerParameters: [],
       response: { type: 'any' },
       responses: { 200: { description: 'some response description' } },
-      pathPattern: 'test/{id}'
+      pathPattern: '/test/{id}'
     }
   ]
 };
@@ -71,7 +71,7 @@ const multipleOperationApi: OpenApiApi = {
           schemaProperties: {}
         }
       ],
-      pathPattern: 'test/{id}',
+      pathPattern: '/test/{id}',
       response: { type: 'string' }
     },
     {
@@ -89,7 +89,7 @@ const multipleOperationApi: OpenApiApi = {
           schemaName: 'RefType'
         } as OpenApiReferenceSchema
       },
-      pathPattern: 'test',
+      pathPattern: '/test',
       response: {
         $ref: '#/components/schemas/ResponseType',
         schemaName: 'ResponseType'
@@ -110,7 +110,7 @@ const docsApi: OpenApiApi = {
       queryParameters: [],
       headerParameters: [],
       response: { type: 'any' },
-      pathPattern: 'test'
+      pathPattern: '/test'
     }
   ]
 };
@@ -124,6 +124,17 @@ describe('api-file', () => {
     expect(apiFile(multipleOperationApi, 'MyServiceName')).toMatchSnapshot();
   });
 
+  it('serializes api file with multiple operations and references and base path', () => {
+    expect(
+      apiFile(
+        multipleOperationApi,
+        'MyServiceName',
+        undefined,
+        '/base/path/to/service'
+      )
+    ).toMatchSnapshot();
+  });
+
   it('creates an api file with documentation', () => {
     expect(apiFile(docsApi, 'TestService')).toMatchSnapshot();
   });

diff --git a/packages/openapi-generator/src/file-serializer/api-file.ts b/packages/openapi-generator/src/file-serializer/api-file.ts
@@ -16,25 +16,28 @@ import type {
  * Serialize an API representation to a string representing the resulting API file.
  * @param api - Representation of an API.
  * @param serviceName - Service name for which the API is created.
+ * @param options - Options to configure the file creation.
+ * @param basePath - Custom base path for the API.
  * @returns The serialized API file contents.
  * @internal
  */
 export function apiFile(
   api: OpenApiApi,
   serviceName: string,
-  options?: CreateFileOptions
+  options?: CreateFileOptions,
+  basePath?: string
 ): string {
   const imports = serializeImports(getImports(api, options));
   const apiDoc = apiDocumentation(api, serviceName);
   const apiContent = codeBlock`
 export const ${api.name} = {
-  ${api.operations.map(operation => serializeOperation(operation)).join(',\n')}
+  _defaultBasePath: ${basePath ? `'${basePath}'` : undefined},
+  ${api.operations.map(operation => serializeOperation(operation, api.name)).join(',\n')}
 };
 `;
 
   return [imports, apiDoc, apiContent].join(unixEOL);
 }
-
 /**
  * Get the unique reference schemas for all request body types in the given operation list.
  * @param operations - The given operation list.