Documentation GeneratorConsole

The console UI can be used to make live calls to an API. It can perform authentication (username/password, API key, or OAuth 2.0) via OpenAPI's security definitions. You can also implement custom authentication schemes by adding JavaScript to the page (see Including Assets).

LucyBot offers several OpenAPI extensions for customizing the API console, including setting default field values, or populating dropdowns with API responses.

Example

routes:
  /API_Console:
    ui: console
    for: acme_api

specifications:
  acme_api:
    - openapi: ./openapi.yml