API Builder


The API Builder is the section which to create the API on the APINIZER and design the generated API.

Figure : Defining Fake API

Table: API Builder

Fields Descriptions
Name Name of API.
Description Description of API.
Fake API If API is fake you can click to this checkbox
Servis URL The base URL of web service to create API.If API is fake ,this part is invisible

Authorization

  • Authorization process is performed on users or user groups from the Authorization

Figure: Authorization User

  • The Everyone checkbox is checked to make the same authorization to everyone. Select either Owner, Edit or View.

Figure: Authorization Everyone

  • To authorize only a specific user, the user to be authorized will be added from the list to the page by clicking the + button in Users and one of the Owner, Edit or View options is selected from the Authority column.

Figure: User Selection

Figure: Authorizing Specific User

  • To authorize only a specific user group, the user to be authorized will be added from the list to the page by clicking the + button in the User Groups and selecting one of the Owner, Edit or View options from the Authority column.

Figure: User Group Selection

Resim:Figure: Authorizing Specific User Group

Endpoint Definition

  • The process of creating a new endpoint is started by clicking the Create Endpoint button.

    Figure : Endpoint Definition



  • Endpoints can contain parameters, by clicking the + button the parameter can be added.

    Figure : Parameter Definition

Table: Parameter Definition

Fields Descriptions
Name Name of parameter.
Description Description of parameter.
Type Type of parameter such as header,path,body
Data Type Data type of parameter
  • Endpoints may have a response template, a click can be added by clicking the + button.

    Figure : Response Definition

Tablo: Response Definition

Fields Descriptions
Code HTTP code of response is entered
Description Additional information about the response can be written.
Model Name The name of the model is entered.
Model Content It is the content of the model that the endpoint created will return against the user’s request.

Figure : Sample Fake API Definition

After completing the API design, click the Create Gateway button to create a gateway to the API.