swagger editor 3.0 save file to location

For more information, see Swagger documentation. Swagger is a set of tools based on this specification for writing, documenting, and consuming REST APIs. In 2.0, you can say that an operation accepts a file, but you cannot say that this file is of a specific type or structure.An OpenAPI Specification (OAS) is a description format for REST APIs. This is supported in OpenAPI 3.0, but not in OpenAPI/Swagger 2.0. Note also that file uploading in Swagger UI only works for POST requests, because HTML forms in browsers support GET and POST methods only.Ĭan I define the Content-Type for uploaded files? That is, Swagger 2.0 does NOT support something like: curl -upload-file archive.zip

Uploads where the payload is just the raw file contents are not supported in Swagger 2.0, because they are not multipart/form-data. You can use POST, PUT or any other method, provided that the operation consumes multipart/form-data. Swagger 2.0 supports file upload requests with Content-Type: multipart/form-data, but does not care about the HTTP method. Note that this will not produce the file upload interface in Swagger UI. For now, you can use a binary string array as a workaround for uploading an arbitrary number of files: type: array However, uploading an arbitrary number of files (an array of files) is not supported. You can have several named file parameters, each defined individually: parameters: The corresponding HTTP request payload will include multiple parts: POST /uploadĬontent-Disposition: form-data name='note' Upload a File + Other Dataįile parameters can be sent along with other form data: parameters:ĭescription: Description of file contents. Swagger UI displays file parameters using a file input control, allowing the users to browse for a local file to upload.

This definition corresponds to the following HTTP request: POST /uploadĬontent-Type: multipart/form-data boundary=abcde12345Ĭontent-Disposition: form-data name='upfile' filename='example.txt' The file parameter must have type: file: paths: The operation payload is defined using formData parameters (not body parameters). That is, your API server must consume multipart/form-data for this operation: consumes: Swagger 2.0 supports file uploads sent with Content-Type: multipart/form-data.

To learn about the latest version, visit OpenAPI 3 pages. OAS 2 This page applies to OpenAPI Specification ver.

Swagger editor 3.0 save file to location