Yuno Docs is built with Readme.io, providing all the needed information to use Yuno API. In addition, in the API Reference, you can also perform requests to understand and test Yuno API directly through your browser.
On the left panels of API Reference, all sections with HTTP verb tags provide code examples and the option to perform requests:
Here we are going to use the Create Customer case to explore the available information and operations you can perform directly with Yuno Docs.
Accessing the Create Customer page, or another page with an HTTP verb tag, you will see:
- A description with relevant information about the request and your request history. All tests performed are listed in the Your Request History area, where you can view requests for up to 30 days.
- Parameter fields to edit your request data accompanied by a brief description. By entering data into these fields, Yuno Docs automatically generate the request code for you. The generated code is shown on the code block shown in 6.
- Response list with possible responses for the request and its response body description.
- Available languages to generate the request code.
- API credentials fields. You must provide your credentials here to successfully test your requests to the Yuno API.
- Testing request area with requests and responses code examples. It presents the Request card on top and the Response Card on the bottom. The generated code by entering data into the parameter fields is provided here.
Yuno Docs provides a complete list of programming languages to automatically generate the request code example. Selecting the desired language provides the requested code and code to install necessary libraries.
You can access Yuno Docs code examples for requests and responses. Clicking on Examples will pop up a list of options to select. After selecting the desired one, the request or response code will be replaced on the respective card.
After entering the request data through the parameter fields or loading an example and providing your credentials, you can test your request. By clicking on Try It!, Yuno Docs sends your request using code inside the Request Card. In addition, you can copy the request code using the copy button on the left bottom of the Request Card.
Yuno Docs will present the response on the Response Card, just below the Request Card, containing the status code and body data received.
You can copy the response body using the copy button on the left bottom of the Response Card.
Updated about 2 months ago