Testing a REST API
The fundamental concept in any RESTful API is the resource. A resource is an object with a type, associated data, relationships to other resources, and a set of methods that operate on it. Only a few standard methods are defined for the resource (in line with the standard HTTP GET, POST, PUT, and DELETE methods).
To test a REST API
1. Switch to the API Gallery page.
Alternatively go to the Home page and type the beginning of the API name into the search box.
2. Click View details for an API.
3. Click Try API in the API details page.
The resources that can be tested are displayed in the left panel.
4. Select a resource.
The methods associated with the resource that can be tested are displayed. If a method is protected by APIKey, OAuth2 or JWT, the same is indicated by a lock symbol.
Note: The HTTP PATCH support is available in API Portal 9.12 onwards.
5. Click a method.
6. Provide the following required values:
Path parameters: Type a value for the Path parameters.
Query parameters: Type a query parameter and its corresponding value. You can add multiple entries by clicking +.
Header parameter > Headers: Type in the required Header name and corresponding value. You can add multiple entries by clicking +.
Header parameters > Security: You can select any of the following authentication types
No Auth: Specifies that no authentication is required.
Basic authentication: Specifies basic authentication of user credentials is required. Type the username and password for authentication and click
Update.
Oauth 2.0: Specifies OAuth authentication is required. Provide the required information to fetch a OAuth token to use for authentication. For details on how to generate a OAuth token and use it see,
OAuth 2.0 Support.
JWT: Specifies a JSON Web token is required for authentication. Type a token or select one of the available tokens in the list and click
Update. For details on how to generate a JSON web token and use it see,
Testing a JWT protected API.
7. Click Test.
The request and the response of the API are displayed.
To clear all data, click Clear.