Skip to end of metadata
Go to start of metadata

An API Builder application contains a file called package.json located in the root directory of the project. API Runtime Services uses the package.json file to configure settings and install dependencies for the application.

Important fields for API Builder applications are defined below and may be different from the npm version.

Dependencies

The application can import any third-party modules that are supported by standard Node.js applications. Before publishing the app to the cloud, make sure all dependencies are listed in the dependencies field in the application's package.json file. For example, to add support for MongoDB 1.2.0 or greater: 

Engines

You can specify which version of Node.js to run your application on. Use the engines field in package.json to specify engine versions. To specify the Node.js version, set the node key in the engines dictionary to a specific version of Node.js to use. For example, to specify to use version 0.10.22:

You may specify any version of Node. Node 0.8.26, 0.10.22 and 0.12.4 are built in, but other versions will be downloaded from https://nodejs.org/ when the application is built prior to running npm install.  If you do not specify a Node version, the application will use 0.12.4 by default.

Deprecated Behavior

Icon

Prior to API Runtime Services 1.2.0, if this field is undefined when you publish your application, the application will use 0.10.22 by default.

If this field is undefined when you republish your application and the latest supported Node.js version changed on the API Runtime Services servers, you will receive an error message when trying to publish your application. You must set the Node.js version to republish your application.

Health check

Starting with API Runtime Services 1.2.0, you may define a health-check endpoint called arrowPing.json that returns a 200 HTTP code. To let API Runtime Services know you defined the health-check endpoint, set the healthCheck field to true.  For an example, see API Builder Tools Project: Optional Health Check.

By default, the health check starts after a two minute wait period. If your application normally takes longer than two minutes to start up, you should set the start_period environment variable to an appropriate start up time (in minutes) to avoid having the docker swarm restart your application before it is online.

Main

API Runtime Services uses the main field in package.json to determine the application's main entry point. Set this field to a JavaScript file. API Runtime Services loads and runs this file first.

By default, the main field is set to the app.js file located in the project's root folder: 

You can load a module by leaving this field blank and specifying the scripts field.

Name

Use the name field to specify the name of the application. An app's name must be unique across all apps of a user or organization. It will be used to ID the app when publishing/unpublishing to the cloud or setting up the app through CLI commands.

By default, this field is set to the name of the project when it was created. 

npmAuthentication

To enable authenticated package installs from a private npm registry specified by npmRegistry, add the npmAuthentication field in your application's package.json file and set it to true

When enabled, you must provide login credentials for the npm registry when calling  acs publish . You can provide the credentials on the command line when calling the  publish  command: 

Icon

If acs cli complains that npm is not found even though npm is in the path, ensure that the directory containing npm is in the NODE_PATH (e.g. NODE_PATH=/usr/lib/node_modules).


If no credentials are provided on the command line, the Appcelerator CLI will attempt to read the credentials from ~/.npmrc. If no ~/.npmrc file is found, or it does not contain any credentials, you are prompted for the npm username and password: 

Note: If you use a private npm registry hosted by Nodejitsu, you must first synchronize your public npm user account with the private npm, otherwise you will get "unauthorized" error. To do this, enter the following npm commands: 

See https://www.nodejitsu.com/documentation/npm/cli/ for more information.

npmRegistry

If you want to use a different npm registry besides the official public npm registry to install dependencies, add the npmRegistry field to the package.json and set the value to the registry URL you want to use. For example, the entry below uses a European npm mirror:

To require authentication for npm installs, add the npmAuthentication field to your package.json file.

Scripts

Preinstall and postinstall

Specifies a path to a script to execute before or after the application is built.  You can use the script to install custom binaries in the project folder.

Prior to API Runtime Services 1.3.0, you could also use the script to install custom binaries outside the project directory. 

Icon

Do not name the script install.sh, located in the root folder of the project. The name is reserved to specify a script to install binaries to the container.

Start

If your application's package.json file does not specify a main field, Appcelerator Cloud will now look at the scripts.start field in package.json to determine the main module to launch. Appcelerator Cloud will execute the start script using npm start.

See the NPM documentation on the "scripts" package.json field.

For example, to launch the foo module: 

Version

The version of the application. Used to version the application.

By default, this field is set to 1.0.0