Versions Compared

Old Version 3

changes.mady.by.user Al Lusher (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Jessica Tomkins

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

(If you haven't created an example workspace, create a workspace called papihello. See Using Workspaces) 

Open the example workspace by pointing your browser to the URL:

...

Create a new API json file by clicking the New button and selecting API file. The file will be opened and the Canvas, Parameters, API Routes, and Properties panel will be initialized.

   Image Added                  

Set Properties

On the left hand lower panel select the General Info tab and fill on the following values

...

For this example, there are no parameters so just click Execute to test the endpoint.

Section


Column

Image Added

After running the test the panel will update with several responses.

  1. Curl - This box will present the Curl command that can be run to consume the REST endpoint
  2. Request URL - the URL of the request. In the case of a GET request this URL can be copied and pasted into the Address bar of your browser to test the endpoint directly from the browser.
  3. Server response - The server response section includes the HTTP code returned as well as the Response body and headers.

...

  1.  
  2. Response body - In this case the response body includes our parameter with the Hello World message.
  3. Response headers - includes all of the headers returned from the server  
  4. The Response section shows what response types should be expected including any default values that were defined in the parameters.


Live Test

The API endpoints are live as soon as they are saved. As mentioned above, for a simple GET endpoint you can test the endpoint in your browser by copying the Request URL and pasting it in your browser address bar.

Image Added