Accelerated API definitions

Neptune DXP offers an API Designer composed of a user interface to define a REST API. This can be useful if an API provider you wish to onboard cannot produce an OpenAPI specification to be imported, or you are starting a new API from scratch and don’t want to write a technical specification with JSON or YAML.

accelerated api

Neptune DXP accelerates the definition of your APIs by enabling the definition of

  • Endpoints as versioned service descriptors of business resources, for example, customers, orders, inventory.

  • Data Model Definitions as abstractions of business entities used by APIs

  • Resources representing business capabilities accessible by one or more operations, describing the CRUD actions possible to master and edit POST/GET etc., implemented by a:

    • Request containing: a) Parameters, outlining query/filtering criteria to be applied on the resulting data set expected from the API response. b) Content Body using the endpoint’s data definition models to describe and compose the payload data of the request.

    • Response containing: a) Status(es) to communicate success or failure of the response. b) Content Body using the endpoint’s data definition models to describe and compose the payload data of the response.