Docs‎ > ‎Reactive Logic Tutorial‎ > ‎

API Project Samples


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 API project samples, their purpose, and how to load them. You can use similar load procedures for your own API projects. Many of the samples are already pre-loaded in the Jetty package.

Sample Databases

Live API Creator provides the following sample API systems:

 API Functional Summary Purpose
NorthwindThe 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 system from the New API wizard.
Illustrates a few simple rules on a well-known reference database.
Business Logic DemoA 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.
SampleOrder Entry, Departments database of few dozen tables, with complex logic and relationships.Used in the Logic Tutorial to illustrate advanced rules and database concepts.
B2BExtension 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 Exercise to confirm your understanding of API Live Creator.
BankingFunds Transfer application, patterned after TP1 samples often used for performance testing.Illustrates a small system requiring only a few dozen lines of code.
TasksCaptures 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.Create an API with one line of code.
 DB Sequences Technical sample - generating keys, database sequences Using 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 Demo and Sample Databases are available, or require installation.

Account Type

How can I tell

Business Logic Demo DB & API Project

Sample 

DB and API Project
Sample Project
On-premises
  • You installed the war file
  • Your URL looks like: http://localhost:8080/APIServer/APICreator/index.html
  • server: http://localhost:8080/APIServer 
Not created - use the procedures on this page
download here
Not created - use the procedures on this page
download here
Not created - use the procedures on this page
Jetty
  • You installed the Jetty package
  • Your URL looks like: http://localhost:8080/APICreator/index.html
  • server: http://localhost:8080
Automatically installed Automatically installed Automatically installed

Create or Verify the Business Logic Demo and Logic Sample Databases

Complete one of the following:
  • If you are using the WAR file, create the Business Logic Demo and Logic Sample databases.
  • If you are using another installation besides the WAR file, the Sample Database was already created while building your server. You can verify it in your favorite database tools.
Complete the following if you are using the WAR file.
  1. Export and unpack the project export file. These contain, for the Business Logic Demo and Logic Sample databases, the following files:
    • The API project .JSON file download. These files are created when you export your API definition. For more information about exporting API definitions, 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 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 using MySqlWorkbench by querying the customer table. The following image shows the query:

        Create the Sample API Projects

        API Projects are the definitions you create for your data sources, your API (custom resources, etc), your logic, and your security. Just like the API projects you create, the sample projects have been exported as a .JSON file download. Use the following procedure to import them.

        Perform the following procedures once for the Logic Sample database and once (as required) for the Business Logic Demo database.

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