API docs: openapi-v3.requestbody.file

Home > @loopback/openapi-v3 > requestBody > file

requestBody.file variable

Define a requestBody of file type. This is used to support multipart/form-data based file upload. Use @requestBody for other content types.

OpenAPI file upload

Signature:

file: (properties?: {
        description?: string | undefined;
        required?: boolean | undefined;
    } | undefined) => (target: object, member: string, index: number) => void

Example

import {Request} from ‘@loopback/rest’;

class MyController {
  @post('/pictures')
  upload(
    @requestBody.file()
    request: Request,
  ) {
    // ...
  }
}