OAS Creator

Edit online

The OpenAPI Specification (OAS) Creator tool generates OpenAPI specification from backend database or XML schema files. This tool supports a code-first approach for building API services.

Generate OpenAPI specifications with create, retrieve, update, and delete operations from database tables or uploaded XML schema files. The tool outputs specifications in YAML or JSON format and includes all required paths, schemas, and operations.

Key highlights

Retrieves configured table and schema details from backend services.
Generates API service code by using the OpenAPI specification as input.

The following operations are supported in the OAS Creator tool:

This operation connects to a data source by using the provided credentials and generates a complete OpenAPI specification with create, retrieve, update, and delete operations for the specified table. For more information, see Generate OpenAPI specification for API Agent sources table.
This operation processes an uploaded XML schema file and generates a complete OpenAPI specification for the defined entities. For more information, see Generate an OpenAPI specification from schema file.

Generate OpenAPI specification from API Agent sources table

This operation connects to the data source by using the provided credentials, generates an OpenAPI specification with create, retrieve, update, and delete operations for the selected table, and displays the result as a downloadable YAML file.

Table 1. Parameters
Parameter	Required	Description
`Table_name`	Yes	Name of the table for which the OpenAPI spec must be created.
`schema_name`	Yes	Name of the table's schema for which the OpenAPI spec must be created.
`object_name`	Yes	Name of the object that is `"schema_name"+_+"table_name"`
`source_id`	Yes	Unique ID for API Agent sources configured source.

Example prompts

Generate an openapi for a customers table with the schema name purchase_order

Create an openapi for a customers table with the schema name purchase_order

Suggested next action

Enter the following prompt:

Generate some Python FastAPI server code based on the following openapi @customers_openapi.yaml

Generate an OpenAPI specification from an XML schema file

This operation generates an OpenAPI specification with create, retrieve, update, and delete operations for the uploaded XML schema, and displays the result as a downloadable YAML file.

Table 2. Parameters
Parameter	Required	Description
`Table_name`		Uploaded schema file name as table name.
`schema_file_name`	Yes	Uploaded schema file name for which the OpenAPI specification must be created.

Example prompts

Generate an openapi spec from @schema.xml

Suggested next action

Enter the following prompt:

Generate some Python FastAPI server code based on the following openapi @customers_openapi.yaml