Docs‎ > ‎Live API‎ > ‎

API Docs

Swagger integration is provided as shown, to document your API.

Besides API Documentation, this drives several tools in the Swagger ecosystem, such as generation of client sdks.

Behavior too

Also, note you can document the behavior of your API, using Topics.

Using Swagger

Swagger starts by showing a list of APIs.  In Espresso, these are your database objects (tables, views and stored procedures), and your Custom Resources.

You can access Swagger from the REST Lab as shown at right., or from the menus:
  1. Deselect Short Menus
  2. Click Quick Ref (left nav bar)
  3. Click the API Documentation tab
  4. Click View Documentation
You can expand the list as shown here to List the Operations.  You can further Expand the Operations to see the JSON details (expand the thumbnail below).


The Swagger specification for your Espresso Logic project is available at the URL specified in the URL box near the Swagger logo. You can use it (possibly with the API key on the URL, e.g. .../@docs/Customers?auth=MyApiKey:1)

REST APIs

Swagger's popularity has resulted in a rich ecosystem of tools built around Swagger.  These are available for your Espresso server.

For example, you can generate client side SDKs for your Espresso API

API Documentation Services

Your Espresso API includes endpoints for Swagger generation:

  • You can get detail on a specific endpoint using @docs/customers, as shown here

ċ
EndPointDetail.json
(3k)
Val Huber,
Sep 16, 2014, 10:26 AM
ċ
docs.json
(2k)
Val Huber,
Sep 15, 2014, 10:10 AM