PromMethodCounter decorator breaks swagger documentation

[HansG89]

When using the PromMethodCounter decorator on a controller function it will break the API documentation beginning from the line where the decorator was added.

Example

The following code generates API documentation for ApiOperation, ApiResponseand Data. But it will not generate documentation for the query parameters.

    @Get()
    @ApiOperation({ title: 'Get something by query string' })
    @ApiResponse({ status: 200, type: Data, description: 'List of Data objects' })
    @PromMethodCounter()
    public async getAllData(@Query() query: GetByQuery): Promise<Data[]> {
        this.logger.info(`GET / by query`);
        return await this.dataService.loadAllData().toPromise();
    }

When I switch the order of decorators, only the basic documentation for the GET function is generated. Everything else is missing (also the model for Data)

    @Get()
    @PromMethodCounter()
    @ApiOperation({ title: 'Get something by query string' })
    @ApiResponse({ status: 200, type: Data, description: 'List of Data objects' })
    public async getAllData(@Query() query: GetByQuery): Promise<Data[]> {
        this.logger.info(`GET / by query`);
        return await this.dataService.loadAllData().toPromise();
    }

When I remove PromMethodCounter the API documentation is working as expected.

[spike008t]

Could you please tell me which packages version you have for

• @nestjs/*
• @nestjs/swagger

I just give a try with latest versions of nestjs and swagger with the latest v0.2.2, all seems works correctly.

[HansG89]

Hi,

I updated all packages recently. But the problem is still there.

dependencies:

• "@nestjs/common": "^6.10.14",
• "@nestjs/core": "^6.10.14",
• "@nestjs/platform-express": "^6.10.14",
• "@nestjs/swagger": "^4.1.1",
• "@nestjs/typeorm": "^6.2.0",

dev dependencies:

• "@nestjs/cli": "^6.13.1",
• "@nestjs/schematics": "^6.7.6",
• "@nestjs/testing": "6.10.14",

[HansG89]

The problem is still there with the latest 7.x version of nestjs and "@nestjs/swagger": "^4.5.12"

[spike008t]

Could you provide me a git sample project to reproduce it? Otherwise, could you try with the latest v1.0.0 available ?

[danshapir]

still not working with latest versions of everything