When you have finished configuring your API, Scheer PAS API Management allows you to test your implemented configurations.
There are slight differences between the testing of a public API and the testing of a private API:
- Private APIs are only accessible for known consumers, called clients in API Management context. For Private APIs, a contract must be created between the client and the API it wishes to consume. If you want to test a Private API, you need to test it via one of the created clients.
- Public APIs can be invoked by any consumer. However, API Management still allows to restrict access to Public APIs by adding policies.
While testing, you can check if the API is invokable. If you have configured policies for an API, you can also check if these policies are applied correctly.
API Definition
To test an API with API Management, you need to provide an API definition in Swagger format. For more information on API definitions, refer to Managing APIs > Definition.
If the API has been imported from the API Catalog, the definition file should have been added automatically. |
If you have added policies to your API setup, you may have to add some information to the API definition file, e.g. regarding tokens that need to be supplied.
Testing the API
The process of testing itself is the same regarding public and private APIs. However, how to access the test page within API Management differs.