Getting Started‎ > ‎

API Project Samples

Text Box

Max, our engineering lead, likes to say:

If it's not in source control, it does not exist.

This page is dedicated to a corollary:

If it's not illustrated in a sample, it might as well not exist.

This page includes a list of the API samples, their purpose, and how to load them. You can use similar load procedures for your own APIs. Many of the samples are included with the demonstration package, which is a self-contained, single-user version of Live API Creator based on Jetty.

API Project Samples

Live API Creator provides the following sample API samples:

API SamplesFunctional SummaryPurpose
CSV ImporterCreates database tables from spreadsheets/CSV files.A complement to managed databases and an example of metadata APIs.
Marketing SampleAccepts conferences with booth and speaking opportunities, gathers responses, and enforces budget.A complete system from a standing start. Creates database, UI, and API with logic.
Northwind API project sample
The Northwind API is created as part of the Tour when you first start Live API Creator in a browser. The tour uses the pre-installed Derby database, including a few sample resources and rules.

You can access this sample API when creating a new API.
Illustrates a few simple rules on a well-known reference database.
Business Logic API project sample
A simple database consisting of six tables (customer, orders, items, products). Used to illustrate basic concepts.Illustrates rules on the smallest database we think is worth exploring.
Logic Sample database
Order Entry, Departments database of few dozen tables, with complex logic and relationships.Used in the Reactive Logic Tutorial to illustrate advanced rules and database concepts.
Business to Business ExampleExtension of Northwind to integrate with Partners and Suppliers, as well as multiple databases.Illustrates several integration concepts, and scripted API creation. This database contains an important Readiness Lab to confirm your understanding of Live API Creator.
Banking API project sample
Funds transfer application, patterned after TP1 samples often used for performance testing.Illustrates a small system requiring only a few dozen lines of code.
Tasks API project sampleCaptures task breakdowns, their assignments to people, sprints and releases, with controls for balancing and time posting.A complex system, and useful for your projects, built in about a day, yet providing meaningful functionality.
No DBThe Hello World is a simple API with no database.Creates an API with a line of code.
Database Sequences API project sampleTechnical sample, such as generating keys and database sequences.Uses JDBC connections to generate primary keys.

Account Types

The following table summarizes the different account types that are available. Your account type determines whether the Business Logic API sample and Logic Sample database are available or require installation.

Account TypeHow can I tell?Available or requires installation?Sample DB and APISample Project
On-premise
  • You installed the WAR file. For more information about installing the WAR file, see Installing.
  • Your URL looks like:
    http://localhost:8080/APIServer/APICreator/index.html
  • Your API Server URL looks like:
    http://localhost:8080/APIServer
Not created. Create the LogicDemo demo application using the procedures on this page.

For more information about downloading this demo application, see the LogicDemo page on GitHub.
Not created. Create the LogicSample demo application using the procedures on this page.

For more information about downloading this advanced sample application, see the LogicSample page on GitHub.
Not created. Create this demo application using the procedures on this page.
Jetty
  • You installed the self-contained, single-user version of Live API Creator, which is a demonstration package based on Jetty.
  • Your URL looks like:
    http://localhost:8080/APICreator/index.html
  • You API Server URL looks like:
    http://localhost:8080
Automatically installed.Automatically installed.Automatically installed.

Create and Verify the Business Logic API Project Sample and Logic Sample Database

If you are using the Web application ARchive (WAR) file, create the Business Logic API sample and Logic Sample databases. Otherwise, the Logic Sample database was already created while building your server. You can verify it in your favorite database tools.

For more information:

  1. Export and unpack the project export file. The Business Logic API sample and Logic Sample databases contain the following files:
    • The API's .JSON export file. Export files are created when you export your API.
      For more information about exporting APIs, see Import and Export API Definitions.
    • SQL files. Use these files to initialize the schema and data.
  2. Create the dblocal_demo and dblocal_sample schemas.
    For more information about creating schemas, see the "Create the Admin DB Schema" procedure in 
    Install on Apache Tomcat.
  3. Load the schema and sample data from the .sql file.
  4. (Optional) Verify the database is created by querying the customer table using MySqlWorkbench. The following image shows the query:
The Business Logic API sample and Logic Sample databases are created.

Create the Sample API Projects

APIs are the definitions you create for your data sources, your API (including custom resources), your logic, and your security. Just like the APIs you create, the sample projects are available as .JSON file downloads. Use the following procedure to import them.

Complete this procedure once for the Logic Sample database and once (as required) for the Business Logic API sample.

For more information:

Prerequisite: You have exported and unpacked the project export file.
  1. Create a new API by importing the unpacked .JSON file.
    For more information about how to import API definitions
    , see Import and Export API Definitions.
  2. Fix the imported API by re-supplying the security information that was not included in the .JSON export file.
    For more information about how to fix imported APIs, see 
    Import and Export API Definitions.
  3. Verify your sample APIs by going to REST Lab or Data Explorer and see if your tables, views, and resources are working.

The sample APIs are created.