By default, all defined sections are visible, and INFO is always visible. Modify what appears in your left-side panel by clicking on the three-dot button next to INFO. In the left-side panel, a menu populates with the sections in the table below. You should see the same errors arise.Īdd line 15 back to move forward with this guide. To replicate the error in the screenshot above with the Pet Store API example, delete “tags:” from line 15. If there are breaking errors, the right- and left-side panels will not render.Įrror details include the error type, line number, and error message.įor error specifics, see the bottom of the center panel. Linting and Error MessagingĪll specifications imported into Insomnia are linted, and error messages will appear at the bottom of the center panel. Otherwise, if you’re starting from scratch, you can start typing right into the center panel. For a URL, provide the URL where the specification file lives. For a file, select the file to import from your computer. This dropdown allows you to select between a File or URL. In the center panel of the Design tab, you’ll see an Import button. In this panel, you can directly edit the specification.Īlternative Option: Rather than use the sample Pet Store API file, you can import from a file or URL. The Pet Store specification will populate in the center panel of the Design tab. Click on start from an example (above the Import button), which will populate the sample Pet Store API. We’re going to import a sample file that’s built into Insomnia. The Design tab is the first of three top-level tabs in Documents. Test: Create test suites and individual tests for requests.Debug: Create, edit, and send individual requests.Design: Import and edit specifications, see API overview content, and preview a rendering of the API.We’ll walk through each tab in order from left to right, starting with the Design tab.ĭocuments have functionality separated into three tabs: Design, Debug, and Test. We’ve named our Document “petstore” as our example uses the Pet Store API. If you’re looking for information about Collections instead (which use Version Control Sync), see Request Collections.įor this guide, create an empty Document from your Dashboard. They also offer the capability to sync with Git. Design Documents (also called Documents) hold specifications, API requests, and tests.

Insomnia rest client download