Options for creating single API that handles both file upload and creation of a model instance with user supplied information?

[rlyttle]

Hi,

I've been trying to create an API which allows the user to create a Product instance with information they supply and upload an image for that product in a single API call.

I have been able to achieve file uploads for existing Product instances with APIs such as the following:

@post('/products/{id}/image')
  async setLogoImage(
    @param.path.number('id') productId: number,
    @requestBody.file() req: Request,
    @inject(RestBindings.Http.RESPONSE) resp: Response,
  ): Promise<Image | undefined> {
    // Handle file upload
    let productImagePayload = await this.fileUploadService.uploadPublicFileAndGeneratePayload(fileReq, resp);
    return await this.productRepository.image(createdProduct.id).create(productImagePayload);
  }

The above works, but @requestBody.file() seems to prevent adding any normal @requestBody params as would be done in normal 'create product' API calls.

@requestBody({
      content: {
        'application/json': {
          schema: getModelSchemaRef(Product, {partial: true}),
        },
      },
    })
    product: Product,

The only option I've been able to get working so far is the following - but I'm concerned that it's hacky and seems like a bad solution:

@post('/products/', {
    responses: {
      '200': {
        description: 'Create product with image',
        content: {'application/json': {schema: getModelSchemaRef(Product)}},
      },
    },
  })
  async createProductWithImage(
    @param.path.number('id') ownerId: typeof Owner.prototype.id,

    // The only way to pass in params as well as our file
    // @param.query.string('title') title: typeof Product.prototype.title,
    // @param.query.string('description') description: typeof Product.prototype.title,

    // Pass in query param of our product, but getModelSchemaRef isn't working, and it seems to be treated as a string
    @param.query.object('product', getModelSchemaRef(Product, {partial: true})) inputProduct: string,

    // The file itself
    @requestBody.file() fileReq: Request,
    @inject(RestBindings.Http.RESPONSE) resp: Response,

  ): Promise<Product> {

    console.log('createProductWithImage() - product = ' + JSON.stringify(inputProduct) );
    const productPayload = new Product( JSON.parse(inputProduct) as Product );      // THIS SEEMS BAD!

    // Create product
    let createdProduct = await this.ownerRepository.products(ownerId).create( new Product({
      title: productPayload.title,
      description: productPayload.description
    }));

    // Upload image and attach to product
    let productImagePayload = await this.fileUploadService.uploadPublicFileAndGeneratePayload(fileReq, resp);
    let productImage = await this.productRepository.image(createdProduct.id).create(productImagePayload);

    // ... omitted: link the createdProduct and the image

    return createdProduct
}

The above works, but damn it seems like a hacky solution.

Swagger gives me an error - it seems the @param.query.object getModelSchemaRef(Product) doesn't work:

Any advice on how to proceed? Ideally I want to pass in a file and a normal JSON payload, but I suspect it's not that straight forward as that would be mixing mime types.

[rlyttle]

Anyone? :)