javascript - tutorial - swagger node js

Cómo publicar archivos en swagger?

Question

Estoy usando Swagger para documentar mis Servicios REST. 1 de mi servicio requiere que se cargue el archivo CSV. Después de especificar las siguientes propiedades para la sección de parámetros en el archivo JSON, puedo obtener la opción de carga de archivos en mi página de swagger.

{
       "name": "File",
       "description": "The file in zip format.",
       "paramType": "body",
       "required": true,
       "allowMultiple": false,
       "dataType": "file"
}

Pero cuando selecciono un archivo y hago clic en Recibir el error NS_ERROR_XPC_BAD_OP_ON_WN_PROTO: Operación ilegal en el objeto prototipo WrappedNative en jquery-1.8.0.min.js (línea 2) , su procesamiento continuo y no recibo ninguna respuesta.

Answer 1

El mío parece funcionar con

 "paramType": "formData",
 "dataType": "file",

Answer 2

Tenga en cuenta que para Swagger 2.0 (OpenAPI Specification 2.0), el objeto Parameter permite que el type se configure como archivo :

  consumes:
    - multipart/form-data  # and/or application/x-www-form-urlencoded
  parameters:
    - name: file
      in: formData
      description: The uploaded file data
      required: true
      type: file

Descrito por el nombre del campo de type en la especificación 2.0 de OpenAPI :

... "entero", "booleano", "matriz" o "archivo". Si type es "file" , el consumo DEBE ser "multipart / form-data", "application / x-www-form-urlencoded" o ambos y el parámetro DEBE estar en "formData".

Answer 3

finalmente encontré la respuesta para esto, en realidad anteriormente no hay soporte para la carga de archivos , ahora actualizaron el archivo swagger-ui.js . Debe reemplazar su antiguo por uno nuevo y también debe definir estas propiedades en Parámetros para un parámetro particular:

 "paramType": "body",
 "dataType": "file",