Would you like to contribute to the Titanium docs? To get started, sign up for an account on the Appcelerator Wiki and sign our CLA.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Made minor grammar and spelling changes

Table of Contents

Note

The content on this page is for the beta release of API Builder 1.10.0. You may find some information is either missing, incomplete , or in general draft state.

...

  1. Download and install Node.js from http://nodejs.org/#download, which includes the npm package manager needed to install the Appcelerator CLI.
  2. From a console window, run the following command to install the CLI: 

    Code Block
    [sudo] npm install appcelerator -g
  3. After installation, run the setup command to install required components: 

    Code Block
    appc setup

    After the CLI downloads and installs the required components, you will be prompted to loginlog in, select an organization to log into, and asked you will be developing Titanium apps. If this is your first time using Appcelerator Studio, the CLI will ask to send an authorization token to your e-mail account or a text to your mobile phone. Enter the authorization token once you receive it to complete the registration process.

...

SummaryYour app's admin home page.
ConnectorsLists and filters installed connector.
ModelsInterface to help you build models. A model represents data stored from another source.
API Doc & TestAuto-generated documentation about your API endpoints. Provides help for the client application to access your application.
ConfigurationsLists configuration files that you can modify and save within a browser.
LogsLists of access logs, clients trying to access your application.
View DocumentationLinks to Appcelerator's documentation site for API Builder's guide.
Sidebar toggleToggles the width of the sidebar.

You can disable the Admin Console by changing the configuration settings in the conf/default.js file. For now, let's explore some of the features of the Admin Console.

...

  1. Click the  Models button. 
  2. Click the + Model button on the right side.
  3. In theNew Model step,
    1. Enter "simpleuser" in the Model name field (required). The name must be unique for all of the application's models.
    2. Select a Connector from the drop-down list (required). Connectors are use used to persist data to the model.
    3. Add a description.
    4. Click Next to move onto the fields step
  4. In the Create Model Fields step,

    1. Click the + Field button.
    2. Enter "first_name" in the Field name field (required).
       
    3. Set Type to String.
    4. Leave Default value empty.
    5. Add a description.
    6. Check the boxes for Read-only or Required as necessary.
    7. Click the Add field to model button.
    8. Repeat step 4 as necessary to add the "last_name" and "email" fields to this model. After you add the fields, you can configure them by changing properties or adding validation or return logic.
  5. In the API endpoint page,

    1. Make sure the CreateRetrieve, and Update methods are checked. Since the Delete method is not checked, the DELETE api/simpleuser endpoint will not be generated but all the other default endpoints for this model will be.
    2. Click Save to commit your new model to the app.

...

Now that you have created a simpleuser the simpleuser model, let's try to retrieve the model data from the application. In the Admin Console:

...