Skip to main content
In this scenario, Insert usage on DB-2-API in Apinizer Platform will be explained. To get more information about creating DB-2-API, click here.

1. Creating DB-2-API

An API that manages employee records is desired to be created. The name and description fields of DB-2-API are filled and the Save and Next button is clicked. Visual containing DB-2-API settings is provided below: DB-2-API Settings When DB-2-API is created, API and method information is on the left panel, and definition information of the selected method is on the right side. DB-2-API Created

2. Creating Method

Click the Add button to open the method/endpoint creation panel. Adding Endpoint Visual containing method creation settings is provided below: Method Creation Settings After entering necessary parameters, the written query can be tested with the Try It button. Try It Button Visual containing the template returned as test result is provided below: Test Result Template

3. Viewing API Definition Documents

Click the Show Specs link to access the API definition files belonging to Employee Db-2-API. Show Specs Visual containing Spec Information dialog is provided below: Spec Information

4. Creating API Proxy

An API Proxy can be created instantly by clicking the Create API Proxy button from the DB-2-API screen. Create API Proxy When creating the API Proxy, fill in the input fields shown in the visual below and click the Save button. API Proxy Creation Form

4.1 Going Live with API Proxy

Employee API Proxy can be quickly loaded (deployed) onto the defined environment and opened for client consumption. This operation can be managed through the dialog opened by clicking the Deploy button on the API Proxy screen. Deploy Dialog

5. Testing

When the request is sent without adding the parameters expected by the relevant method, the following error response is returned. Error Response When the parameters expected by the relevant method are added to the request and executed, the following response is returned. Successful Response