Forum Discussion

New Contributor

2 years ago

Swagger example for multipart/form-data sending file in body

I am trying to add an example in "examples.json" external file a swagger.yaml. Until now for PUT/POST I have: { "path": "/api/books/{id}", "method": "PUT", "examples": [ { "name": "Update book ...

mhiggins

Staff

      examples: 
        foo:
          summary: A foo example
          value: {"foo": "bar"}
        bar:
          summary: A bar example
          value: {"bar": "baz"}
    'application/xml':
      examples: 
        xmlExample:
          summary: This is an example in XML
          externalValue: 'http://example.org/examples/address-example.xml'

andreiclara

New Contributor

2 years ago

Thank you for your answer, but I don't understand where I can add this example. I was trying to add example in external file "examples.json". The code above should be added in "examples.json" or in swagger.yaml? And what section should I add it? In the responses or schema examples?

Thank you

chichepo
Champion Level 3
2 years ago
Hi andreiclara

the examples are defined under the components clause as shown here
look here for further examples.

Another solution is to save your examples collection within a domain.
In such case, your Domain is defining all your "reusable" definitions, under the components clause.
For example:
In the API file:

In the Domain file:

Let us know if it is enough clear