Open API - Intergraph Smart API Manager - 5.0 - Help

Intergraph Smart API Manager Help

Language
English
Product
Intergraph Smart API Manager
Search by Category
Help
Smart API Manager Version
5.0

All Smart APIs provide a resource at <service root>/doc that serves an Open API 2.0 document to describe the Smart API.

Open API (also called swagger) is a specification used to describe RESTful APIs. The Open API 2.0 document is formatted as JSON and provides several possibilities for documentation. For example, some 3rd-party API management systems consume an Open API document to provide API documentation.

SHARED Tip There is an option to view the document in YAML format, with the following syntax:

<service root>/doc?format=yaml

In addition, a Smart API may also have an embedded version of Smart API Explorer, which provides a full-featured single-page web client to explore and navigate the Smart API.

This resource is located at: <service root>/doc/explorer.

See Explore a Smart API for details.