Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

File/Folder Name
Description
app.jsThe entry point to the connector for testing, which launches a server instance.
appc.jsonProject configuration file. Do not modify this file.
confContains configuration files in JSON format for the connector. The filedefault.js is used for testing the connector. You can create an example configuration file, which is copied to the project when it is installed. See the  Connector Configuration File section.
index.jsThe entry point to the connector.
libContains the logic for your connector. Requires a index.js file. See the Connector Logic section.
logsContains generated log files when running your project locally. If you test the connector, the generated log files will get packaged with the application. You may want to disable logging by setting the transactionLogEnabled property to false in the conf/default.js file.
modelsContains Model JavaScript files, used to declare the schema for your data and generate API endpoints for the connector. See Models and API Endpoints below.
node_modulesContains project dependencies. API Builder automatically installs any project dependencies declared in the package.json file.
package.jsonNPM configuration file to declare project dependencies and other build or runtime configurations.

...