4. Developer Tools


Appframe Data API Explorer

Appframe Data API extension for Visual Studio Code. Provides easy CRUD operations for APIs on defined hosts and can generate Dart model classes from the resources. You can find the source code and additional documentation at Omega365 repository.

Features

List available resources on a host

This extension will add a new tree pane that will contains all the hosts you've added to your settings. Each host can be expanded to list it's api resources.

Add new resources to host

By right-clicking the host-name you can choose to add a new resource entry to it directly from VSCode environment.

Dart model class generator

Clicking on a resource will generate a dart model class for it. The default save path will be used from your extension settings. You must be in a workspace for this feature to work.

Installing

Installation of the extensions can be done via the Marketplace or a terminal command.

  1. Marketplace
    1. Press CTRL + SHIFT + X to open the marketplace in VSCode.
    2. Search for "Appframe Data API Explorer"
    3. Click install
  2. Command line
    1. $ code --install-extension omegaas.appframe-data-api-explorer

Configuration

Some initial configuration is required to get started. You can access these settings under Preferences > Extensions. You must provide your credentials and add your development host(s).


Dart Class Generator

Is a code module that assists a mobile developer in his/hers workflow, by allowing to generate dart model classes from data resources. It's used by the API Explorer extension under the hood to bring a better development experience.

Code module name: Mobile.dartCodeGenerator

How to use?

R4

  1. Ensure that your desired data resources are added to the table in SiteSetup "Data Resources" tab.
  2. Go to /api/dart-class-generator/{PrimKey}, where PrimKey is the PrimKey value of the desired data resource to be generated as a dart class.
    1. PrimKey can be looked up in sviw_System_DataResources view.

    365

    1. All resources are exposed by default, you don't need to manually add them.
    2. Go to /api/dart-class-generator/{PrimKey}, where PrimKey is the PrimKey value of the desired data resource to be generated as a dart class.
      1. PrimKey can be looked up in sviw_System_DataResources view.
           





    Related articles

    Placeholder "LocalizeWeb2016" failed