Neptune DXP API testing client

Neptune DXP provides a full-fledged API client to test the operation of a REST API. The client allows the population of security credentials request details and parameters and presents the response resource’s results fetched from the API endpoint.

The use of the API client allows you to perform unit testing tasks on your APIs without the need for an external test application, such as:

  • Status checks to confirm the correct response code was returned.

  • Syntax checks to confirm if request and responses are well-formed, for example:

    1. Server accepts correct input.

    2. Content type of the returned content was as expected

  • Schema validation establishing if the response payload conforms to an expected structure or format.

  • Functional characteristics of the API, such as:

    1. The server returns a predictable value based on the input condition.

    2. Request predictably modifies a resource all POST/PUT/PATCH/DELETE combos.

    3. Response headers are populated as expected.

    4. Body content results list corresponds to input query parameter request settings.

    5. Service implements idempotency.

  • Security ensuring API requests are correctly authenticated by the identity provider and if relevant authorised by the server resolving the API

  • Performance expected core SLA was met, for example, ⇐50msec

  • Error handling testing for boundary behaviours, for example:

    1. Server rejects incorrect input.

    2. Excluding a required parameter results in an error.

    3. Submitting incorrect data types results in an error.

    4. Negative testing to identify exceptions and race conditions.