Docs‎ > ‎Live API Overview‎ > ‎

API Docs


Swagger

Swagger integration is provided as shown, to document your API.  As of this writing, the Swagger version is 1.2.

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 API Creator, 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 API Creator 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 API Creator server.

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

Calling Swagger in a Browser

You can call the swagger UI using our built-in service and passing in the project URL.  Remember - this will only work if you set the API Property/Settings to allow Swagger to be called without an Auth Token.

http://localhost:8080/APICreator/swagger-ui/index.html?url=http://localhost:8080/rest/default/demo/v1/%40docs

API Documentation Services

Your API includes endpoints for Swagger generation:

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

Connecting

This page on the API Doc will give details on how to connect to your API and give examples.

Code Samples

Various sample code fragments are shown here to help connect and return your REST API's.