Creating an OpenAPI document

To create an OpenAPI document, complete the following steps:

1. Log into API Assistant. For details, see Getting started.
2. Enter the following prompt:

   Create an openapi with the table purchaseorder

   or

   Create an openapi with the table purchaseorder and schema order_demo

   and click Send.
   Note: The schema name is not mandatory, but it becomes necessary if the table name is not unique.
   The APIGenerator tool communicates with the API Assistant sources and displays the proposed plan.

   

3. Click Start to view the results. To view the plan details, expand the arrow icon . The API Assistant generates the OpenAPI document in YAML format.
4. Click the download icon to save the YAML file.
5. In the VS Code left pane, open Explorer to view the downloaded YAML file.