REST Object API - Support for OpenAPI or Swagger UI

REST Object API - Support for OpenAPI or Swagger UI

The Object API now fully supports the OpenAPI standard 3.0.3 for its operations.
From the Open API Initiative, the Open API Specification defines a standard, programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic.
Not only humans can use this specification to easily understand the capabilities of the Object API, but also tools like Postman or other integration tools can read this specification and provide automated features based on it like Query/Response validations, ready to use stub and test code, graphical integration of the service within an orchestration tool etc.
For more information about Open API definitions for the existing ListAPI, see the
Swagger UI
section in the
Informatica MDM - Product 360 Accelerators
guide.
As a customer's repository is very individual, a static API file would not be sufficient. Therefore, a new service API endpoint has been created to obtain the OpenAPI specification individually.
URL Pattern
/object/{entity-identifier}/info
Method
GET
Accept
application/json
If multiple accept headers are defined, they will be evaluated by their order.
The wildcard media type (*/*) will result in XML.
Example
/rest/ V2.0 /object/Article/info
For more information, see the section
REST Object API
in the
Informatica MDM - Product 360 REST Service API
guide.
The Object API fully supports the Open API standard 3.0.3 for its operations.

0 COMMENTS

We’d like to hear from you!