Login if you already have an account



Create a new account. join us!



Need some help? Check out our forum.

July 14, 2012 vprakash@miegoapps.com

Defining Your API

When you create an API on the FatFractal Platform, by default it will happily start learning object types and collection names and extending your API. At some point, you will likely want to exercise more control over it. The FatFractal Definition Language (FFDL, pronounced “fiddle”) not only allows you to view your API’s metadata, it also lets you control your API as well using FFDL command language.

There are two ways to execute FFDL commands to control your API:

Deploying a scaffolded NoServer application

The first method requires that you install the local runtime which also includes a FatFractal command line interface (CLI) that allows you to scaffold, edit and deploy your API footprint to either the FatFractal public cloud, to your local runtime or to a Cloud-in-a-Box installation. Deploying your app causes the FatFractal service to automatically load the application.ffdl file and use that as the explicit definition for your API. The command line tools provide means to keep the cloud version and your local version in sync.

Sending FFDL commands from client code

The second method is used by the Console Application to manage your API settings and configurations using a the executeFFDL method available in client SDKS. A word of caution – this method requires that you login as the system user and you should take great care to keep these credentials secret.

Most developers find the application.ffdl file that is created by application scaffolding to be the easiest and most productive way to structure and control their APIs.

Note – it is not necessary to send a complete FFDL file to make changes – all functions can be executed as individual commands as well.

For More Information

Learn more about FFDL.

Learn more about the FatFractal Console Application.

Learn more about the Local Development Environment.

Learn more about our Command Line Interface (CLI) tools.