Creating an OpenAPI document from an existing source

You can use the API Agent to quickly generate an OpenAPI document from an existing database table or an IBM connector pack-based application. The generated OpenAPI document is in YAML format and can be used for API development, testing, and publishing.

Procedure

  1. Log in to API Agent. For more information, see Getting started.
  2. Enter a prompt to create an OpenAPI document from an existing database and click Send.
    For example,
    • Create an openapi with the table orders
    • Create an openapi with the table orders and schema purchase_order
    Note: The schema name is not mandatory, but it becomes necessary if the table name is not unique.
    The OAS Creator tool communicates with the API Agent sources and displays the proposed plan.
  3. To view the results, click Start. The API Agent generates the OpenAPI document in YAML format.
  4. Click download to save the YAML file.
  5. To view the downloaded YAML file, open Explorer in the left panel of the Visual Studio Code.