Follow these steps to create an example of request body in JSON format from your API platform before performing a basic CRUD operation on a resource.
- Import the Cloud Native SBC Open API specification file(in YAML format) to your API platform such as Swagger, Postman etc.
- Navigate to CRUD operation URL for which you want to create an example in your API platform. For example - POST for config/v1/sd/realm-config.
- View the JSON request under Request Body for the chosen method.
- Copy the request body to the interface/editor that will help you to customize the attribute values.
- Fill in the required attribute values. You can leave the others to their default values or remove the optional attributes from the JSON request body.
You now have the JSON request body to perform a CRUD operation.
- Send the request.
- View the response in JSON format based on your request.
In case the request has error(s) in it, the API platform interface will respond with an error code.
Note:
Depending on your API platform interface, you may obtain the cURL command appended to the response body.