Docs‎ > ‎API Creator‎ > ‎

Manage your API Project

API projects represent the grouping of your database connections, schema, resource endpoints, business rules, and events as well as the security access-control settings. Each API project has a list of one or more registered databases. These API projects are all active and available, or running. You manage the contents of an API project using Live API Creator.

For more information about the list of registered databases, see Data Sources.

Access your API Project

Access your API projects in Live API Creator from the Home page. The following image shows the Home page:

Revalidate the Schema after Making Changes

Live API Creator does not replicate your schema. You can use your existing tools to manage your schema. The rule repository makes reference to schema objects such as table and column names. If you drop or rename tables and columns, synchronize these with your repository. You can revalidate the schema with the rules definitions and show problems.

For more information:

API Project Settings

The following image shows a partial list of the API project settings on the API Properties, Settings tab:

Ignore Client Attempts to Update Aggregate Values

You can authorize Live API Creator to ignore client attempts to update aggregate (sum, count, min, max) values by selecting the Aggregate Default Override checkbox. By default, aggregates (sums, counts, etc) are initialized to zero ('0') on insert, regardless of the client-supplied value. Select this checkbox to throw exceptions when you attempt to update aggregate values

Allow All API Calls using HTTP and HTTPS

You can allow all API calls using HTTP and HTTPs by selecting the HTTPS only checkbox. By default, only HTTPS API calls are allowed. If security is not a major concern for your project, then allow all API calls using HTTP or HTTPS.

Note: Allowing all API calls does not guarantee that the caller used HTTPS. Due to issues related to firewalls and load balancers, a caller can fake this. To force API calls to use HTTPS, turn off the HTTP endpoint on your web server(s) (though even that may still not be a complete guarantee). This is a general HTTP issue.

Change JSON Object @metadata Section Name

Live API Creator returns JSON objects that includes the @metadata section. In some environments, this name can be a problem. You can change the section name for your API project by entering a unique value in the Metadata name field. Choose a name that is unlikely to clash with a column name or a resource attribute name. For example, __metadata__.

Specify the Default Response Format

You can specify the format for API responses using the Default response format drop-down. By default, the standard JSON format is used for responses.
Options: JSON, jsonObject, CSV, and XML.

For more information about this option, see the context help.

Enable Access to Swagger Documentation without Authentication

You can retrieve the Swagger schema without authentication by selecting the Allow Swagger without authentication checkboxBy default, this checkbox is cleared. If you need to connect your API to such a Swagger consumer, select this option temporarily, then clear this checkbox after the API has been retrieved. Allowing Swagger without authentication is useful because many Swagger consumers do not support authentication (even though theSwagger "standard" itself does).

To retrieve the Swagger schema, use a URL similar to the following:
https://myserver.acme.com/rest/acme/proj1/v1/@docs

Disallow free-form filters and sorts

When you need maximum flexibility in filtering your data, you can use regular filters, such as:

.../rest/acme/myproj/v1/Customer?filter=balance<1000

To turn off regular filters, select the Disallow free-form filters and sorts checkbox. By default, this checkbox is cleared. When free-form filters and sorts are disallowed (regular filters are turned off) and a request specifies a filter in the URL, the request fails.

For more information:

  • About structured filters, including regular filters, see Structured Filters.
  • About this option, see the context help.

Specify the Level of Security Debugging Information Live API Creator Sends

You can specify the level of debugging information Live API Creator sends API callers , including why the security layer behaves the way it does. By default, Live API Creator does not send API callers debugging information and the value for the Provide detailed security debugging field is zero ('0'). You can specify a value between zero ('0') and five ('5'). Values one ('1') to five ('5') provide increasing levels of debugging information. Security debugging information is useful during development and debugging, but may not be as useful in production.

For more information about this option, see the context help.

Specify the String to Emit in for Positive Infinity Values

Specify the string to emit in for positive infinity values using the JSON Positive Infinity option. By default, the string value that is emitted is null.

For more information about this option, see the context help.

JSON Negative Infinity

This option specifies the string to emit in for negative infinity values. By default, the string value that is emitted is null.

For more information about this option, see the context help.

JSON NaN (Quiet)

This option specifies the string to emit in for quiet not a number (NaN) values. By default, the string value that is emitted is null.
For more information:

JSON NaN (Signaling)

This option specifies the string to emit in for signaling not a number (NaN) values. By default, the string value that is emitted is null.

For more information:

Binary Output Encoding

You can have your binary data emitted as a HEX string, a Base 64 string of values, or as an HTTP link to the download endpoint. API Creator emits binary data as encoded HEX or Base 64 string. By default, the data is encoded as a HEX string.

For more information about this option, see the context help.

Force Binary Data as an Object

When emitting binary data, you can force binary data as an object. By default, the Force Binary Data as an Object checkbox is cleared. Select to force the output to be an object. If the output is larger than the value you set in the Inline Limit Default field (by default, 2000 bytes), then the output is always an object.

For more information:

Force Consistent Pagination when no primary key

When retrieving data, you can ensure proper pagination by appending the primary key to any pre-existing ordering. Databases do not provide any guarantee of the order of records retrieved unless there is an order-by.

For more information about this option, see the context help.

Select the Java and JavaScript Libraries using the Libraries tab

The Libraries tab displays a list of the Java and JavaScript libraries for your API project. You can use one or more of these in your JavaScript logic by selecting them here. For example, many projects will use date arithmetic, so would select the Moment Library. Select only libraries that you use since there is a (small) memory impact for every additional library you selected. You can upload new Libraries (JAR files) and JavaScript files.

For more information:

Specify URLs for Documentation

You can specify URLs for Documentation which are shown in tabs on the Designer Home Page. Specify the URLs in project settings. The links must be https (for example, you can designate Google Sites).

Define Topics and Link them to Logic

While logic is automatically invoked for relevant transactions, it is very useful to capture business requirements, and the logic that implements them. You can define topics and link them to logic.

For more information:
  • About topics, see Topics.
  • About defining topics using the Topics tab, including how to add/edit or remove topics used to define groups or rules, see API Properties.

Create Predefined Named Filters and Named Sort Expressions

You can create predefined named filters that allow customized expressions that mask the internal column and SQL syntax.

For more information:

Latest Changes Tab

This is an audit of administration changes to the selected API project. For more information about viewing the audit trail of changes using the Latest Changes tab, see API Properties.