Tsed: [Question] Multipart + Swagger

[tomer-amir-vonage]

Informations

Type | Version
---|---
Question | 4.x

---

Description

I am trying to create a multipart endpoint (file upload).
I used the example in the docs and it seems to work fine, but I can't make the swagger doc show the file field of the request. I am also using a path param.

Here is an example

import { Controller, PathParams, Post } from '@tsed/common';
import { MultipartFile } from '@tsed/multipartfiles';

type MulterFile = Express.Multer.File;

@Controller('/api')
export default class FileCtrl {

    @Post('/:username')
    test(@MultipartFile() myFile: MulterFile, @Required() @PathParams('username') username: string) {
        // Logic ...
    }
}

swagger result:

paths:
  '/api/{username}':
    post:
      parameters:
        - in: path
          name: username
          type: string
          required: true
      consumes: []

Expected Result:

paths:
  '/api/{username}':
    post:
      consumes:
         - multipart/form-data
      parameters:
        - in: path
          name: username
          type: string
          required: true
        - in: formData
          name: myFile
          type: file
          description: The file to upload.
      responses:
        '200':
          description: Success

Am I doing something wrong? or is this missing functionality?

Thanks!

Acceptance criterias

• [ ] Example (log, usecase, etc...)
• [ ] Ts.ED version (bug/question)

[Romakita]

Multipart decorators didn't add information for the swagger spec.

[Romakita]

this issue can help you : #378

[tomer-amir-vonage]

Thanks for the fast response!
this helps:

@Operation({consumes: ["application/x-www-form-urlencoded"]})

But I can't seem to set the type to file

[Romakita]

ha ok... Hum we need to improve the multipartfile module for that.

[tomer-amir-vonage]

@Romakita do you have an estimate when it will be added? 😄

[Romakita]

Work in progress :)

[tomer-amir-vonage]

Thanks!
Tested and it's looking good! waiting for #311 to be resolved and I'll upgrade 😄

[tomer-amir-vonage]

Hi @Romakita!

Found two small issues,
The new code adds a creates the following swagger:

paths:
  '/api/{username}':
    post:
      consumes:
         - multipart/form-data
      parameters:
        - in: path
          name: username
          type: string
          required: true
        - in: formData
          required: false # This fails validation and it's missing the "name" field
          type: file

There are two issues are:

1. It is missing the name field
2. It has a required: false field which fails swagger validation

should be:

paths:
  '/api/{username}':
    post:
      consumes:
         - multipart/form-data
      parameters:
        - in: path
          name: username
          type: string
          required: true
        - in: formData
          name: myFile # <-- this is missing
          type: file

Thanks for all your help!

[tomer-amir-vonage]

Hi @Romakita!
Did you verify the issue? 😄

[Romakita]

Hi @TomerAmirV,

This problem is fixed with the latest release. It support only a single file right now. Multiple file isn't support by swagger ui with the swagger 2.0 spec

[tomer-amir-vonage]

@Romakita, the second bug I reported is in version 4.23.1, after the first fix

[tomer-amir-vonage]

Hi @Romakita, any news on the second bug?

[Romakita]

ok. I didn't seen your second issue. Currently, the name doesn't exists with the Multipartfile decorator. Multipartfile use anonymous field name and swagger accept this configuration.

[tomer-amir-vonage]

I think this was fixed, and it's working in version 4.25.0 🎉