Post a json body with swagger

by

You need to use the body parameter:

    "parameters": [
      {
        "in": "body",
        "name": "body",
        "description": "Pet object that needs to be added to the store",
        "required": false,
        "schema": {
          "$ref": "#/definitions/Pet"
        }
      }
    ],

and #/definitions/Pet is defined as a model:

"Pet": {
  "required": [
    "name",
    "photoUrls"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "category": {
      "$ref": "#/definitions/Category"
    },
    "name": {
      "type": "string",
      "example": "doggie"
    },
    "photoUrls": {
      "type": "array",
      "xml": {
        "name": "photoUrl",
        "wrapped": true
      },
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "xml": {
        "name": "tag",
        "wrapped": true
      },
      "items": {
        "$ref": "#/definitions/Tag"
      }
    },
    "status": {
      "type": "string",
      "description": "pet status in the store",
      "enum": [
        "available",
        "pending",
        "sold"
      ]
    }
  },
  "xml": {
    "name": "Pet"
  }
},

Ref: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore.json#L35-L43

OpenAPI/Swagger v2 spec: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object

For OpenAPI v3 spec, body parameter has been deprecated. To define the HTTP payload, one needs to use the requestBody instead, e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore.json#L39-L41

OpenAPI v3 spec: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#requestBodyObject

More Related Contents:

  1. Create REST API without using any backend
  2. OpenAPI: what schema to accept any (complex) JSON value
  3. OpenAPI query string parameter with list of objects
  4. OpenAPI path/query parameters nested structure serialization
  5. How do I POST JSON data with cURL?
  6. What is “406-Not Acceptable Response” in HTTP?
  7. Posting a File and Associated Data to a RESTful WebService preferably as JSON
  8. How to call nested json data using API in flutter?
  9. Use of PUT vs PATCH methods in REST API real life scenarios
  10. pinterest api documentation [closed]
  11. Disable Hypertext Application Language (HAL) in JSON?
  12. How do I send a JSON string in a POST request in Go
  13. What is the difference between resource and resource representation in REST?
  14. Curl GET request with json parameter
  15. REST with Spring and Jackson full data binding
  16. Why does RestTemplate not bind response representation to PagedResources?
  17. How do I include subclasses in Swagger API documentation/ OpenAPI specification using Swashbuckle?
  18. JSON parse error: Can not construct instance of java.time.LocalDate: no String-argument constructor/factory method to deserialize from String value
  19. Flutter Registration with API
  20. Spring REST service: retrieving JSON from Request
  21. RESTful API Testbed with Swagger
  22. Unable to find a MessageBodyReader of content-type application/json and type class java.lang.String
  23. JSON, REST, SOAP, WSDL, and SOA: How do they all link together
  24. Modify default JSON error response from Spring Boot Rest Controller
  25. JsonMappingException: could not initialize proxy – no Session
  26. How do I combine multiple OpenAPI 3 specification files together?
  27. Using VBA and VBA-JSON to access JSON data from WordPress API
  28. REST API Best practices: args in query string vs in request body
  29. How do I restrict JSON access?
  30. Can Server Sent Events (SSE) with EventSource pass parameter by POST

Leave a Comment