GithubHelp home page GithubHelp logo

Comments (5)

alisherks avatar alisherks commented on July 30, 2024 4

It's not possible for the same reason as Array or T[] (look at the issue microsoft/TypeScript/issues/10576).
You could try the following:

export abstract class ServiceApiResponse<T> {
  abstract get value(): T;
  
  @ApiModelProperty({ type: Number })
  pages: number;


  @ApiModelProperty({ type: Number })
  page: number;

  @ApiModelProperty({ type: Number })
  maxByPage: number;


  @ApiModelProperty({ type: Number })
  count: number;

  @ApiModelProperty({ type: Object })
  error: any;
}

export class PatientCaretrackPopulatedOutputResponse extends ServiceApiResponse<PatientCaretrackPopulatedResponse[]> {
  @ApiModelProperty({ type: PatientCaretrackPopulatedResponse, isArray: true })
  value: PatientCaretrackPopulatedResponse[];
}

from swagger.

omar avatar omar commented on July 30, 2024 3

Cross posting this, does that mean a generic controller wouldn't be able to expose the proper endpoints? For example, something like this (taken from nestjs/nest#228):

export abstract class EntityController<T> {
    constructor(protected readonly service: EntityService<T>) { }

    @Get()
    async findAll() {
        return this.service.findAll();
    }

    @Get(':id')
    async getById(@Param() params) {
        return this.service.getById(params.id);
    }

    @Post()
    async create(@Body() data: Partial<T>) {
        return this.service.create(data);
    }
}

from swagger.

QuentinLeCaignec avatar QuentinLeCaignec commented on July 30, 2024 1

Running into the same issue, having a generic CRUD controller being inherited is incredibly useful but for PUT and POST methods SwaggerUI is not implicitly picking up the T model.

I've tried specifying the model type with
@ImplicitApiBody({ name: 'data', type: thid.entityType })
where this.entityType is the actual Model declared in the child controller.

I've tried various ways of passing the model constructor to the generic parent controller and have @ImplicitApiBody work, to no avail.

Is there a way for Swagger to find the @Body type "T" in a generic parent controller like CrudController ?

from swagger.

workfel avatar workfel commented on July 30, 2024

Hi @alisherks, this works fine.
Thanks

from swagger.

lock avatar lock commented on July 30, 2024

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

from swagger.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.