Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add array query params support (default) #145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+134 −11
Open

Add array query params support (default) #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 53 additions & 7 deletions __tests__/services/UriBuilder.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ describe('UriBuilder tests', () => {
dtoType: 'string',
name: 'id',
place: ParameterPlace.Path,
isModel: false
isModel: false,
isCollection: false,
}
],
returnType: {
Expand Down Expand Up @@ -59,7 +60,8 @@ describe('UriBuilder tests', () => {
name: 'name',
optional: false,
place: ParameterPlace.Query,
isModel: false
isModel: false,
isCollection: false,
}
],
returnType: {
Expand All @@ -84,6 +86,45 @@ describe('UriBuilder tests', () => {
expect(result).toEqual(expected);
});


test('method with array query param', () => {
// Arrange
const model: IMethodModel = {
kind: MethodKind.Default,
name: 'get',
operation: MethodOperation.GET,
parameters: [
{
dtoType: 'string',
name: 'name',
optional: false,
place: ParameterPlace.Query,
isModel: false,
isCollection: true,
}
],
returnType: {
isCollection: false,
isModel: true,
type: {
dtoType: 'IProduct',
kind: PropertyKind.Object,
type: 'Product',
isNullable: true
}
},
originUri: 'get'
};

const expected = '`get?${(name.map(x=> `name=${encodeURIComponent(x)}`).join(\'&\'))}`';

// Act
const result = uriBuilder.buildUri(model);

// Assert
expect(result).toEqual(expected);
});

test('method with one path and one query params', () => {
// Arrange
const model: IMethodModel = {
Expand All @@ -95,14 +136,16 @@ describe('UriBuilder tests', () => {
dtoType: 'string',
name: 'id',
place: ParameterPlace.Path,
isModel: false
isModel: false,
isCollection: false,
},
{
dtoType: 'string',
name: 'name',
optional: false,
place: ParameterPlace.Query,
isModel: false
isModel: false,
isCollection: false,
}
],
returnType: {
Expand Down Expand Up @@ -138,20 +181,23 @@ describe('UriBuilder tests', () => {
dtoType: 'string',
name: 'customer',
place: ParameterPlace.Path,
isModel: false
isModel: false,
isCollection: false,
},
{
dtoType: 'string',
name: 'type',
place: ParameterPlace.Path,
isModel: false
isModel: false,
isCollection: false,
},
{
dtoType: 'string',
name: 'date',
optional: false,
place: ParameterPlace.Query,
isModel: false
isModel: false,
isCollection: false,
}
],
returnType: {
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@luxbss/gengen",
"version": "1.2.8",
"version": "1.2.9",
"description": "Tool for generating models and Angular services based on OpenAPIs and Swagger's JSON",
"bin": {
"gengen": "./bin/index.js"
Expand Down
1 change: 1 addition & 0 deletions src/generators/angular/AngularServicesMethodGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ export class AngularServicesMethodGenerator {
case ParameterPlace.Query:
statement.type = this.getFullTypeName({
type: parameter.dtoType,
isCollection: parameter.isCollection,
isModel: parameter.isModel,
isOptional: parameter.optional
});
Expand Down
1 change: 1 addition & 0 deletions src/models/method-parameter/IParameter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ export interface IParameter {
dtoType: string;
place: ParameterPlace;
isModel: boolean;
isCollection: boolean;
}
1 change: 1 addition & 0 deletions src/models/method-parameter/IQueryParameter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ import { IParameter } from './IParameter';
export interface IQueryParameter extends IParameter {
place: ParameterPlace.Query;
optional: boolean;
isCollection: boolean;
}
13 changes: 13 additions & 0 deletions src/models/method-parameter/MethodParameterModelBase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { OpenAPIService } from '../../swagger/OpenAPIService';
import { OpenAPITypesGuard } from '../../swagger/OpenAPITypesGuard';
import { IOpenAPI3Parameter } from '../../swagger/v3/parameter';
import { IOpenAPI3Reference } from '../../swagger/v3/reference';
import { IOpenAPI3ArraySchema } from '../../swagger/v3/schemas/array-schema';
import { OpenAPI3SimpleSchema } from '../../swagger/v3/schemas/schema';
import { lowerFirst } from '../../utils';
import { ParameterPlace } from '../kinds/ParameterPlace';
Expand All @@ -12,6 +13,7 @@ export abstract class MethodParameterModelBase implements IParameter {
public name: string;
public dtoType!: string;
public isModel!: boolean;
public isCollection: boolean = false;
public abstract place: ParameterPlace;

constructor(
Expand All @@ -34,6 +36,11 @@ export abstract class MethodParameterModelBase implements IParameter {
return;
}

if (this.typesGuard.isCollection(this.model.schema)) {
this.setupCollection(this.model.schema);
return;
}

if (this.typesGuard.isEnum(this.openAPIService.getRefSchema(this.model.schema))) {
this.setupRef(this.model.schema);
return;
Expand All @@ -47,6 +54,12 @@ export abstract class MethodParameterModelBase implements IParameter {
this.isModel = true;
}

private setupCollection(schema: IOpenAPI3ArraySchema): void {
this.dtoType = this.typesService.getSimpleType(schema.items as OpenAPI3SimpleSchema).dtoType;
this.isModel = false;
this.isCollection = true;
}

private setupSimple(schema: OpenAPI3SimpleSchema): void {
this.dtoType = this.typesService.getSimpleType(schema).dtoType;
this.isModel = false;
Expand Down
9 changes: 8 additions & 1 deletion src/models/method-parameter/QueryMethodParameterModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,27 @@ import { TypesService } from '../../services/TypesService';
import { OpenAPIService } from '../../swagger/OpenAPIService';
import { OpenAPITypesGuard } from '../../swagger/OpenAPITypesGuard';
import { IOpenAPI3Parameter } from '../../swagger/v3/parameter';
import { IOpenAPI3ArraySchema } from '../../swagger/v3/schemas/array-schema';
import { ParameterPlace } from '../kinds/ParameterPlace';
import { IQueryParameter } from './IQueryParameter';
import { MethodParameterModelBase } from './MethodParameterModelBase';

export class QueryMethodParameterModel extends MethodParameterModelBase implements IQueryParameter {
public place: ParameterPlace.Query;
public optional: boolean;
isCollection: boolean;

constructor(model: IOpenAPI3Parameter, typesGuard: OpenAPITypesGuard, typesService: TypesService, openAPIService: OpenAPIService) {
constructor(model: IOpenAPI3Parameter, typesGuard: OpenAPITypesGuard, typesService: TypesService, openAPIService: OpenAPIService, isCollection: boolean = false) {
super(typesService, model, typesGuard, openAPIService);
this.optional = this.getOptional(model);
this.isCollection = this.getIsCollection(model);
this.place = ParameterPlace.Query;
}

private getIsCollection(model: IOpenAPI3Parameter): boolean {
return (model.schema as IOpenAPI3ArraySchema)?.type === 'array';
}

private getOptional(model: IOpenAPI3Parameter): boolean {
return model.required === undefined ? false : !model.required;
}
Expand Down
5 changes: 4 additions & 1 deletion src/services/UriBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ export class UriBuilder {
}

private getQueryParams(params: IParameter[]): string {
const pairs = params.filter((z) => z.place === ParameterPlace.Query).map((z) => `${z.name}=\${encodeURIComponent(${z.name})}`);
const pairs = params.filter((z) => z.place === ParameterPlace.Query)
.map((z) => z.isCollection ?
`\${(${z.name}.map(x=> \`${z.name}=\${encodeURIComponent(x)}\`).join('&'))}` :
`${z.name}=\${encodeURIComponent(${z.name})}`);

if (!pairs.length) {
return '';
Expand Down
3 changes: 2 additions & 1 deletion src/swagger/v3/parameter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { IOpenAPI3Reference } from './reference';
import { IOpenAPI3ArraySchema } from './schemas/array-schema';
import { OpenAPI3SimpleSchema } from './schemas/schema';

export interface IOpenAPI3Parameter {
name: string;
in: 'query' | 'header' | 'path' | 'cookie';
required?: boolean;
schema?: OpenAPI3SimpleSchema | IOpenAPI3Reference;
schema?: OpenAPI3SimpleSchema | IOpenAPI3Reference | IOpenAPI3ArraySchema;
}
50 changes: 50 additions & 0 deletions swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,56 @@
}
}
},
"/api/v1/Product/Items/GetByIdsQuery": {
"post": {
"tags": [
"Product"
],
"parameters": [
{
"name": "ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
}
}
}
}
}
},
"/api/v1/Product/Items/GetByIds": {
"post": {
"tags": [
Expand Down