When looking at the details of a published service, you want to make sure that the API will do what you have in mind.
To allow you to test the API, the swagger documentation is available which makes it really easy to check out how the API works.
The quality of the documentation fully depends on the service developer who created and published the API. You can contact the service developer regarding this.A published API version is subject to change. New API versions will be published when breaking existing contracts. When an API exposes new endpoints or adapts the implementation logic of services without impacting an endpoint, the API version remains the same.Thus it is possible that the API documentation is modified during the lifecycle of an API service version. As an API consumer, you should be aware that the documentation for a published service version is subject to change.
- 1.Select an API and look at the details on the Documentation tab.
- 2.The swagger documentation consists of the list of endpoints and the base URL:
- 3.When you click on a resource, it expands and the list of available endpoints is displayed. For example, look at the
- 4.You can further unfold an endpoint and see different composing elements. Let's look at
/system/status. You will see the implementation notes, response class model schema, and a list of response messages:
- 5.If you are in possession of one or more contracts with this service, you can test the endpoint. For example, click 'Try it out!' on the
/system/statusendpoint. The response includes the Curl, the request URL and request headers. It also includes the response body, response code and response headers:
Performing tests assures you of the functionality which is available through the API. You can decide whether this API delivers what you are looking for.