api-operation-get.decorator.md

@ApiOperationGet(args: IApiOperationGetArgs)

Decorate method for getting a resource in your controller.

Example:

@ApiPath( {
    path : "/versions",
    name : "Version"
} )
@controller( "/versions" )
@injectable()
export class VersionController implements interfaces.Controller {
    public static TARGET_NAME: string = "VersionController";
    private data: [any] = [
        {
            id : "1",
            name : "Version 1",
            description : "Description Version 1",
            version : "1.0.0"
        },
        {
            id : "2",
            name : "Version 2",
            description : "Description Version 2",
            version : "2.0.0"
        }
    ];

    @ApiOperationGet( {
        description : "Get version object",
        summary : "Get version",
        responses : {
            200 : { description : "Success", type : SwaggerDefinitionConstant.Response.Type.ARRAY  , model : "Version" }
        }
    } )
    @httpGet( "/" )
    public getVersions( request: express.Request, response: express.Response, next: express.NextFunction ): void {
        response.json( this.data );
    }
}

IApiOperationGetArgs

path: string

Define particular path of operation. Default is path parameter in @ApiPath.

• Optional

description: string

Define description of operation.

• Optional

summary: string

Define summary of operation.

• Optional

parameters: IApiOperationArgsBaseParameters

Define parameters in path, body, query and formData.

• Required

responses: {[key: string]: IApiOperationArgsBaseResponse}

Define all responses.

• Required

produces: string[]

Define type list that resource produce.

• Optional
• Default is global type list defined in ISwaggerBuildDefinition when execute .express(options: ISwaggerExpressOptions)

tags: string[]

Define custom tags for operation

• Optional

security: {[key: string]: any[]}

Define security

• Optional

Example:

    ...
    @ApiOperationGet( {
        ...
        security : {
            basicAuth : []
        }
    } )
    ...
}

Configuration

Example:

    app.use( swagger.express(
        {
            definition : {
                ...
                securityDefinitions : {
                    basicAuth : {
                        type : SwaggerDefinitionConstant.Security.Type.BASIC_AUTHENTICATION
                    },
                    apiKeyHeader : {
                        type: SwaggerDefinitionConstant.Security.Type.API_KEY,
                        in: SwaggerDefinitionConstant.Security.In.HEADER,
                        name: "apiHeader"
                    }
                }
            }
        }
    ) );

deprecated: boolean

Define deprecated

• Optional