Using with API Express

Using the API Express Generator.

Appery.io Visual App Builder provides a special tool named API Express Generator to perform AppClient initial setup for your API Express services.

API Express Generator

API Express Generator is an extension that allows you to generate multiple REST API services based on the models created with API Express. With this extension, services and JavaScript files are created automatically and can be used in the app as usual to perform CRUD operations.

This extension is available for the following app types:

  • Ionic 5.
  • jQuery Mobile;

🚧

API Express Project

In order to use API Express Generator, you need to create an API Express project and use the Generate APIs option to generate APIs for a relational database table.

API Express Generator can not be used for custom APIs.

To import services into the App Builder:

  1. Open an existing or create a new app, then click Create New > Extensions > API Express Generator:
207207

Launching API Express Generator.

  1. A new tab will open where you can select the API Express domain. Keep the default selected value (Appery.io) and click the Next button.
  2. In the next screen, you will see a list of all your API Express projects. Select the project which services you want to import into this app and click the Select button.
11701170

API Express projects.

  1. You will see services available in this API Express project. For the service group, you want to import, click the generate button.
11661166

Selecting a service group to generate services.

  1. After you click generate you will see a popup where you can set the service's name. You can keep the default name (APIExpressService) or enter a new name and click Generate.
  2. Save all the changes and refresh the App Builder page. This is needed so that the generated services appear in the Services folder:
232232

Generated services

All the basic operations services as well as the JavaScript, have been successfully generated.

API Express Generator creates an​ AppClientSettings service file with project settings and the API Express API key.

Another way to locate the project API key is to go to API Express > Project > Settings.

πŸ“˜

Making Changes

If you update your API Express service you should run the extension again to update the services in the App Builder.

API Express Models Services

Additionally, the following services can be generated for the selected model(s):

426426

πŸ“˜

API Express Models Services Sample App

You can check this sample app tutorial that explains how to use AppClient models with Appery.io Database directly.