10min

API Inspector

You can test your REST and GraphQL APIs right inside Sizzy using the API Inspector.

You can find the API Inspector in the Debugging Panel.

Document image

Getting Started

Start by clicking the "Add Request" button.

Document image



Enter a name for your request.

Document image

Select your request type, enter the URL, and click send.

Document image

Customizing the Request

Request Headers

You can customize the request headers in the Headers tab. You can also enable/disable a header using the checkbox next to it.

Document image

Request Body

Sizzy allows you to send API requests with the following body types

The appropriate content-type header is automatically added based on the body type you select. You can add the header manually to override this.

Plain

Send you body content in plain text.

Document image

JSON

Use the pretty JSON editor to send your content in JSON format.

Document image

GraphQL

The API Inspector also supports GraphQL requests with the GraphQL editor. You can enter both the queries and variables.

Document image

Multipart form/ URL encoded form

The form editor allows you to send the request body as either URL encoded form or multipart form data.

Document image

Viewing the Response

You will a similar request after a successful API call. You can either view the response raw, or formatted according to the content type. If a JSON response is sent, you can even browse the JSON object using the structured JSON viewer.

Document image

Manage your requests

You can create/delete requests using the buttons in the Request Panel header.

Document image

To rename a request, simply click on its name and start editing.

Document image

You can switch between your created requests by clicking on the Dropdown icon next to the request name.

Document image

All your requests are tied to your Projects. When you switch to another project, all your requests will switch too, and you can continue where you left off when you come back to the previous project.



Updated 12 Jul 2022
Did this page help you?
Yes
No