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.

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

Develop #29

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
119 changes: 63 additions & 56 deletions src/lib/swagger-express-ts/api-model-property.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,61 +1,68 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
import {SwaggerService} from "./swagger.service";
import {IApiOperationArgsBase} from "./i-api-operation-args.base";

export interface IApiModelPropertyArgs {
/**
* Define if property is required.
* Optional. Default is false.
*/
required?: boolean;

/**
* Define format of property. Example: SwaggerDefinitionConstant.Definition.Property.Format.INT_64
* Optional.
*/
format?: string;

/**
* Define type of property. Example: SwaggerDefinitionConstant.Definition.Property.Type.STRING
* Optional.
*/
type?: string;

/**
* Define description.
* Optional.
*/
description?: string;

/**
* Define enum;
* Optional.
*/
enum?: string[];

/**
* Define model.
* Optional.
*/
model?: string;

/**
* Define type of item. Example: SwaggerDefinitionConstant.Definition.Property.Type.STRING
* Optional.
*/
itemType?: string;
/**
* Define if property is required.
* Optional. Default is false.
*/
required?: boolean;

/**
* Define format of property. Example: SwaggerDefinitionConstant.Definition.Property.Format.INT_64
* Optional.
*/
format?: string;

/**
* Define type of property. Example: SwaggerDefinitionConstant.Definition.Property.Type.STRING
* Optional.
*/
type?: string;

/**
* Define description.
* Optional.
*/
description?: string;

/**
* Define enum;
* Optional.
*/
enum?: string[];

/**
* Define model.
* Optional.
*/
model?: string;

/**
* Define type of item. Example: SwaggerDefinitionConstant.Definition.Property.Type.STRING
* Optional.
*/
itemType?: string;

/**
* Define apiVersion. Example: v1
* Optional.
*/
apiVersion?: string[];
}

export function ApiModelProperty(
args?: IApiModelPropertyArgs
): PropertyDecorator {
return function(target: any, propertyKey: string | symbol) {
const propertyType = Reflect.getMetadata("design:type", target, propertyKey)
.name;
SwaggerService.getInstance().addApiModelProperty(
args,
target,
propertyKey,
propertyType
);
};
export function ApiModelProperty(args?: IApiModelPropertyArgs): PropertyDecorator {
return function (target: any, propertyKey: string | symbol) {
const propertyType = Reflect.getMetadata("design:type", target, propertyKey)
.name;
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addApiModelProperty(
args,
target,
propertyKey,
propertyType
);
});
};
}
17 changes: 10 additions & 7 deletions src/lib/swagger-express-ts/api-model.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
import {SwaggerService} from "./swagger.service";

export interface IApiModelArgs {
description?: string;
name?: string;
description?: string;
name?: string;
apiVersion?: string[];
}

export function ApiModel(args?: IApiModelArgs): ClassDecorator {
return function(target: any) {
SwaggerService.getInstance().addApiModel(args, target);
};
return function (target: any) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addApiModel(args, target);
});
};
}
31 changes: 18 additions & 13 deletions src/lib/swagger-express-ts/api-operation-delete.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
export interface IApiOperationDeleteArgs extends IApiOperationArgsBase {}
import {SwaggerService} from "./swagger.service";
import {IApiOperationArgsBase} from "./i-api-operation-args.base";

export function ApiOperationDelete(
args: IApiOperationDeleteArgs
): MethodDecorator {
return function(
target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor
) {
SwaggerService.getInstance().addOperationDelete(args, target, propertyKey);
};
export interface IApiOperationDeleteArgs extends IApiOperationArgsBase {
}

export function ApiOperationDelete(args: IApiOperationDeleteArgs): MethodDecorator {
return function (target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addOperationDelete(
args,
target,
propertyKey
);
});
};
}
27 changes: 17 additions & 10 deletions src/lib/swagger-express-ts/api-operation-get.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
export interface IApiOperationGetArgs extends IApiOperationArgsBase {}
import {SwaggerService} from "./swagger.service";
import {IApiOperationArgsBase} from "./i-api-operation-args.base";

export interface IApiOperationGetArgs extends IApiOperationArgsBase {
}

export function ApiOperationGet(args: IApiOperationGetArgs): MethodDecorator {
return function(
target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor
) {
SwaggerService.getInstance().addOperationGet(args, target, propertyKey);
};
return function (target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addOperationGet(
args,
target,
propertyKey
);
});
};
}
31 changes: 18 additions & 13 deletions src/lib/swagger-express-ts/api-operation-patch.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
export interface IApiOperationPatchArgs extends IApiOperationArgsBase {}
import {SwaggerService} from "./swagger.service";
import {IApiOperationArgsBase} from "./i-api-operation-args.base";

export function ApiOperationPatch(
args: IApiOperationPatchArgs
): MethodDecorator {
return function(
target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor
) {
SwaggerService.getInstance().addOperationPatch(args, target, propertyKey);
};
export interface IApiOperationPatchArgs extends IApiOperationArgsBase {
}

export function ApiOperationPatch(args: IApiOperationPatchArgs): MethodDecorator {
return function (target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addOperationPatch(
args,
target,
propertyKey
);
});
};
}
27 changes: 17 additions & 10 deletions src/lib/swagger-express-ts/api-operation-post.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
export interface IApiOperationPostArgs extends IApiOperationArgsBase {}
import {SwaggerService} from "./swagger.service";
import {IApiOperationArgsBase} from "./i-api-operation-args.base";

export interface IApiOperationPostArgs extends IApiOperationArgsBase {
}

export function ApiOperationPost(args: IApiOperationPostArgs): MethodDecorator {
return function(
target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor
) {
SwaggerService.getInstance().addOperationPost(args, target, propertyKey);
};
return function (target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addOperationPost(
args,
target,
propertyKey
);
});
};
}
27 changes: 17 additions & 10 deletions src/lib/swagger-express-ts/api-operation-put.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
import { SwaggerService } from "./swagger.service";
import { IApiOperationArgsBase } from "./i-api-operation-args.base";
export interface IApiOperationPutArgs extends IApiOperationArgsBase {}
import {SwaggerService} from "./swagger.service";
import {IApiOperationArgsBase} from "./i-api-operation-args.base";

export interface IApiOperationPutArgs extends IApiOperationArgsBase {
}

export function ApiOperationPut(args: IApiOperationPutArgs): MethodDecorator {
return function(
target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor
) {
SwaggerService.getInstance().addOperationPut(args, target, propertyKey);
};
return function (target: any,
propertyKey: string | symbol,
descriptor: PropertyDescriptor) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addOperationPut(
args,
target,
propertyKey
);
});
};
}
24 changes: 15 additions & 9 deletions src/lib/swagger-express-ts/api-path.decorator.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
import { SwaggerService } from "./swagger.service";
import {SwaggerService} from "./swagger.service";

export interface IApiPathArgs {
path: string;
name: string;
description?: string;
security?: { [key: string]: any[] };
deprecated?: boolean;
path: string;
name: string;
description?: string;
security?: { [key: string]: any[] };
deprecated?: boolean;
apiVersion?: string[];
}

export function ApiPath(args: IApiPathArgs): ClassDecorator {
return function(target: any) {
SwaggerService.getInstance().addPath(args, target);
};
return function (target: any) {
const apiVersions = args.apiVersion || ["v1"];
apiVersions.forEach((apiV: string) => {
SwaggerService.getInstance(apiV).addPath(args, target);
});
};
}
Loading