Merge pull request #1 from parsable/feature/PE-2152

Feature/pe 2152

Author: lub0v-parsable

.gitignore

@@ -15,3 +15,4 @@ test/e2e/generated
 samples/generated
 samples/swagger-codegen-cli-v2.jar
 samples/swagger-codegen-cli-v3.jar
+example

README.md

@@ -47,6 +47,8 @@ $ openapi --help
  --exportServices <value> Write services to disk (default: true)
  --exportModels <value> Write models to disk (default: true)
  --exportSchemas <value> Write schemas to disk (default: false)
+ --exportClient <value> Generate and write client class to disk (default: false)
+ --name <value> Custom client class name (default: "AppClient")
 
  Examples
  $ openapi --input ./spec.json
@@ -392,6 +394,29 @@ const getToken = async () => {
 OpenAPI.TOKEN = getToken;
 ```
 
+### Generate client instance with `--exportClient` option
+
+The OpenAPI generator allows to create client instances to support the multiple backend services use case.
+The generated client uses an instance of the server configuration and not the global `OpenAPI` constant.
+
+To generate a client instance, use `--exportClient` option. To set a custom name to the client class, use `--name` option.
+
+```
+openapi --input ./spec.json --output ./dist --exportClient true --name DemoAppClient
+```
+
+The generated client will be exported from the `index` file and can be used as shown below:
+```typescript
+// create the client instance with server and authentication details
+const appClient = new DemoAppClient({ BASE: 'http://server-host.com', TOKEN: '1234' });
+
+// use the client instance to make the API call
+const res: OrganizationResponse = await appClient.organizations.createOrganization({
+ name: 'OrgName',
+ description: 'OrgDescription',
+});
+```
+
 ### References
 
 Local references to schema definitions (those beginning with `#/definitions/schemas/`)

bin/index.js

@@ -19,7 +19,9 @@ const params = program
  .option('--exportServices <value>', 'Write services to disk', true)
  .option('--exportModels <value>', 'Write models to disk', true)
  .option('--exportSchemas <value>', 'Write schemas to disk', false)
+ .option('--exportClient <value>', 'Generate and write client class to disk', false)
  .option('--request <value>', 'Path to custom request file')
+ .option('--name <value>', 'Custom client class name', 'AppClient')
  .parse(process.argv)
  .opts();
 
@@ -36,6 +38,8 @@ if (OpenAPI) {
  exportServices: JSON.parse(params.exportServices) === true,
  exportModels: JSON.parse(params.exportModels) === true,
  exportSchemas: JSON.parse(params.exportSchemas) === true,
+ exportClient: JSON.parse(params.exportClient) === true,
+ clientName: params.name,
  request: params.request,
  })
  .then(() => {

jest.config.js

@@ -5,10 +5,7 @@ module.exports = {
  {
  displayName: 'UNIT',
  testEnvironment: 'node',
- testMatch: [
- '<rootDir>/src/**/*.spec.ts',
- '<rootDir>/test/index.spec.js',
- ],
+ testMatch: ['<rootDir>/src/**/*.spec.ts', '<rootDir>/test/index.spec.js', '<rootDir>/test/index.client.spec.js'],
  moduleFileExtensions: ['js', 'ts', 'd.ts'],
  moduleNameMapper: {
  '\\.hbs$': '<rootDir>/src/templates/__mocks__/index.js',
@@ -29,10 +26,5 @@ module.exports = {
  ],
  },
  ],
- collectCoverageFrom: [
- '<rootDir>/src/**/*.ts',
- '!<rootDir>/src/**/*.d.ts',
- '!<rootDir>/bin',
- '!<rootDir>/dist',
- ],
+ collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!<rootDir>/src/**/*.d.ts', '!<rootDir>/bin', '!<rootDir>/dist'],
 };

package.json

@@ -1,6 +1,6 @@
 {
- "name": "openapi-typescript-codegen",
- "version": "0.9.3",
+ "name": "@parsable/openapi-typescript-codegen",
+ "version": "0.0.1-alpha-2",
  "description": "Library that generates Typescript clients based on the OpenAPI specification.",
  "author": "Ferdi Koomen",
  "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",

src/index.ts

@@ -20,7 +20,9 @@ export type Options = {
  exportServices?: boolean;
  exportModels?: boolean;
  exportSchemas?: boolean;
+ exportClient?: boolean;
  request?: string;
+ clientName?: string;
  write?: boolean;
 };
 
@@ -37,6 +39,8 @@ export type Options = {
  * @param exportServices: Generate services
  * @param exportModels: Generate models
  * @param exportSchemas: Generate schemas
+ * @param exportClient: Generate client class
+ * @param clientName: Custom client class name
  * @param request: Path to custom request file
  * @param write Write the files to disk (true or false)
  */
@@ -50,6 +54,8 @@ export async function generate({
  exportServices = true,
  exportModels = true,
  exportSchemas = false,
+ exportClient = false,
+ clientName = 'AppClient',
  request,
  write = true,
 }: Options): Promise<void> {
@@ -64,17 +70,17 @@ export async function generate({
  switch (openApiVersion) {
  case OpenApiVersion.V2: {
  const client = parseV2(openApi);
- const clientFinal = postProcessClient(client);
+ const clientFinal = postProcessClient(client, exportClient);
  if (!write) break;
- await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
+ await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, exportClient, clientName, request);
  break;
  }
 
  case OpenApiVersion.V3: {
  const client = parseV3(openApi);
- const clientFinal = postProcessClient(client);
+ const clientFinal = postProcessClient(client, exportClient);
  if (!write) break;
- await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
+ await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, exportClient, clientName, request);
  break;
  }
  }

src/openApi/v2/parser/getOperationPath.spec.ts

@@ -2,8 +2,8 @@ import { getOperationPath } from './getOperationPath';
 
 describe('getOperationPath', () => {
  it('should produce correct result', () => {
- expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}/${type}');
- expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}');
+ expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${apiVersion}/list/${id}/${type}');
+ expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${apiVersion}/list/${id}');
  expect(getOperationPath('/api/v1/list/{id}')).toEqual('/api/v1/list/${id}');
  expect(getOperationPath('/api/{foobar}')).toEqual('/api/${foobar}');
  expect(getOperationPath('/api/{fooBar}')).toEqual('/api/${fooBar}');

src/openApi/v2/parser/getOperationPath.ts

@@ -8,9 +8,7 @@ import { getOperationParameterName } from './getOperationParameterName';
  * @param path
  */
 export function getOperationPath(path: string): string {
- return path
- .replace(/\{(.*?)\}/g, (_, w: string) => {
- return `\${${getOperationParameterName(w)}}`;
- })
- .replace('${apiVersion}', '${OpenAPI.VERSION}');
+ return path.replace(/\{(.*?)\}/g, (_, w: string) => {
+ return `\${${getOperationParameterName(w)}}`;
+ });
 }

src/openApi/v3/parser/getOperationPath.spec.ts

@@ -2,8 +2,8 @@ import { getOperationPath } from './getOperationPath';
 
 describe('getOperationPath', () => {
  it('should produce correct result', () => {
- expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}/${type}');
- expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}');
+ expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${apiVersion}/list/${id}/${type}');
+ expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${apiVersion}/list/${id}');
  expect(getOperationPath('/api/v1/list/{id}')).toEqual('/api/v1/list/${id}');
  expect(getOperationPath('/api/{foobar}')).toEqual('/api/${foobar}');
  expect(getOperationPath('/api/{fooBar}')).toEqual('/api/${fooBar}');

src/openApi/v3/parser/getOperationPath.ts

@@ -8,9 +8,7 @@ import { getOperationParameterName } from './getOperationParameterName';
  * @param path
  */
 export function getOperationPath(path: string): string {
- return path
- .replace(/\{(.*?)\}/g, (_, w: string) => {
- return `\${${getOperationParameterName(w)}}`;
- })
- .replace('${apiVersion}', '${OpenAPI.VERSION}');
+ return path.replace(/\{(.*?)\}/g, (_, w: string) => {
+ return `\${${getOperationParameterName(w)}}`;
+ });
 }