API Catalog


API Catalog is a section on defining SOAP and REST APIs on the Apinizer platform, converting database data to web service, and activating integrated services.

Figure: API List

API Creation File Selection

Choose one of the WSDL, WADL, Swagger 2.x, Open API/Swagger 3.x, Define REST API without any description options.

WSDL (SOAP Services)

  • After selecting WSDL , Select source of the file option will be activated.There are Import from URL and Upload the file options.If you select Import from URL,you must enter the URL of the WSDL file.If you select Upload the file, you must define WSDL file from local file system.

Figure: Step-1

  • In the WSDL file imported with the URL, click the gear icon at the end of the URL entry and perform WSDL parsing.

  • The SOAP API is created by clicking the Save button.

Figure: Step-2

WADL (REST Web Services)

  • After selecting WADL , Select source of the file option will be activated.There are Import from URL and Upload the file options.If you select Import from URL,you must enter the URL of the WADL file.If you select Upload the file, you must define WADL file from local file system.

Figure: WADL Step-1

  • In the WADL file imported with the URL, click the gear icon at the end of the URL entry and perform WADL parsing.

  • The REST API is created by clicking the Save button.

Figure: WADL Step-2

Swagger 2.x

After selecting Swagger 2.x , Select source of the file option will be activated.There are Import from URL and Upload the file options.If you select Import from URL,you must enter the URL of the Swagger 2.x file.If you select Upload the file, you must define Swagger 2.x file from local file system.

Figure: Swagger 2.x URL Define

  • In the Swagger 2.x file imported with the URL, click the gear icon at the end of the URL entry and perform Swagger 2.x parsing.

  • The REST API is created by clicking the Save button.

    Figure: Swagger 2.x URL Define After Parsing

Open API/Swagger 3.x

After selecting Open API/Swagger 3.x , Select source of the file option will be activated.There are Import from URL and Upload the file options.If you select Import from URL,you must enter the URL of the Open API/Swagger 3.x file.If you select Upload the file, you must define Open API/Swagger 3.x file from local file system.

Resim: Open API/Swagger 3.x File Define

  • In the Open API/Swagger 3.x file imported with the URL, click the gear icon at the end of the URL entry and perform Open API/Swagger 3.x parsing.

  • The REST API is created by clicking the Save button.

Defining REST API without any description file

If you have not any description file such as WADL,Swagger 2.x,OpenAPI/Swagger 3.x ,you can use this option.

Figure: REST API Without Any Descripton File Define

Endpoints need to be created for the defined REST service to perform its function. End point can be added to the REST service created by clicking the Create Endpoint button.

  • The end method information of the REST API is entered from the Endpoint Definition screen.

    Figure: Endpoint Description

Table: Adding endpoint

Fields Descriptions
HTTP Method The HTTP method that supported by endpoint
Resource URL The relative address of the endpoint.
Name Name of endpoint.
Description Description of endpoint.
Consumes The kind of end point expected
Produces The kind of end point produced
  • Parameter can be added by clicking the + button when the end point parameter is desired.
  • The parameter information of the end method is entered from the Parameter Definition screen that is opened. After the information is entered, click Save button and the process is completed.

Figure: After adding endpoint

API Re-Parse

Existing APIs are replaced with the new specification file with Re-Parse option. Gateways connected to the API do not need to be created again. Changes are automatically applied to gateways.

Figure: API Re-Parse

  • Re-parse operation is done with the original API file. If you created API with Swagger file ,you must reparse API with Swagger file.

Figure: API Re-Parse Swagger

  • After Re-Parse operation, you need to redeploy your gateways.

Figure: After API Re-Parse