DB-to-API Designer


You can open your data as REST service, just by typing SQL queries (SELECT, INSERT, UPDATE, DELETE, PROCEDURE) with DB-to-API Designer.

Figure : DB-to-API

Table: DB-to-API Designer

Fields Descriptions
Name Name of API.
Description Description of API.
Database Connection This is the area where the database connection required for API creation is selected.

Database Connection Pool Definition

  • To create a new database connection, click the + button to start the process.

    Figure : Database Connection

Table: Database Conneciton Pool Definition

Fields Descriptions
Name This section is the name that will be given to the database connection.
Description Detailed information about the database connection can be given.
IP/Host IP / Host information of the database to be connected.
DBMS This is the type of database management system.
Port It is the port number on which the database to be connected is running.
Database Connection This is the area where the database connection required for API creation is selected.
Database It is the schema / database name of the database to be connected.
Username Username of the database user.
Password Password of the database password.
Initial Pool Size The number of connections to be made at the time of installation of the database connection to be established.
Min Pool Size The minimum number of connections that can be found in the database connection to be established.
Initial Pool Size The number of connections to be made at the time of installation of the database connection to be established.
Increment Count It is the information of the number of connections that can be added at a time when the connections in the database connection to be installed are exhausted.
Max Statements It is the information of the maximum number of preparedStatement expressions that will be kept per connection in the database connection to be established.

To test the accuracy of the entered values, click Test Connection  button to check the accuracy.

Adding Method

  • Once the database connection is established, the Methods section will be activated. The method can be added by clicking the Add New Method button.

    Figure : Define Method

Table: Adding Method

Fields Descriptions
Method Name Name of method.
Description Detailed information about the method.
HTTP Method The method to create a response is the HTTP method.
URL The relative address that can be accessed by the method to be created.
Database Process Type Specifies the type of operation to be used in the SQL query.

By clicking the Process SQL  statement button, the results of the SQL statement entered can be checked by clicking the Test SQL  statement button after the parameters are automatically found in the SQL statement. Clicking Save  button saves the relevant method.

Figure : Sample DB-to-API