Toggle navigation
API Docs
LoopBack 4
LoopBack 3.x
View
LoopBack Overview
LoopBack 4
LoopBack 3.x
LoopBack 2.x
Community projects
Contributing to LoopBack
Security advisories
Resources
Docs Github Repo
Announcements Mailing List
Developer Forum
LoopBack on Slack
LoopBack on Stack Overflow
StrongLoop Blog - LoopBack
Translations
Español (v2)
Español (v4)
Français (v2)
Français (v4)
한국어 (v2)
한국어 (v3)
Português (v2)
Português (v4)
日本語 (v2)
日本語 (v3)
日本語 (v4)
Pусский (v2)
中文 (v2)
中文 (v4)
Loopback 2.0
Installation
Installing IBM API Connect
Installing StrongLoop
Installing compiler tools
Installing on MacOS
Installing on Windows
Installing on Linux
Updating to the latest version
Installation troubleshooting
LoopBack core concepts
Routing
LoopBack FAQ
Glossary
StrongLoop Labs
Getting started with LoopBack
Create a simple API
Use API Explorer
Connect your API to a data source
Extend your API
Add a static web page
Add a custom Express route
Next steps
Considerations for GDPR readiness
Getting started part II
Introducing the Coffee Shop Reviews app
Create new data source
Create new models
Define model relations
Define access controls
Define a remote hook
Create AngularJS client
Learn more
Security advisories
08-15-2018
08-08-2018
01-31-2018
03-10-2017
08-16a-2016
08-16-2016
01-12-2016
06-04-2015
01-09-2015
Creating an application
Environment-specific configuration
Versioning your API
Standard project structure
Tutorials and examples
Managing users
Registering users
Logging in users
Partitioning users with realms
User management example
AccessToken invalidation
Authentication, authorization, and permissions
Introduction to User model authentication
Controlling data access
Making authenticated requests
Defining and using roles
Accessing related models
Creating a default admin user
Security considerations
Tutorial: access control
Defining models
Creating models
Using the model generator
Discovering models from relational databases
Creating models from unstructured data
Customizing models
Attaching models to data sources
Exposing models over REST
Validating model data
Creating model relations
Tutorial: model relations
BelongsTo relations
HasOne relations
HasMany relations
HasManyThrough relations
HasAndBelongsToMany relations
Polymorphic relations
Querying related models
Embedded models and relations
Nested queries
Using built-in models
Extending built-in models
Adding remote methods to built-in models
Creating database tables for built-in models
Model property reference
Built-in models REST API
PersistedModel REST API
Access token REST API
ACL REST API
Application REST API
Relation REST API
Role REST API
User REST API
Connecting models to data sources
Creating a database schema from models
Understanding data sources
Using database transactions
Executing native SQL
Building a connector
Implementing create, retrieve, update, and delete methods
Implementing model discovery
Implementing auto-migration
Working with data
Creating, updating, and deleting data
Querying data
Fields filter
Include filter
Limit filter
Order filter
Skip filter
Where filter
Advanced topics: data
Realtime server-sent events
AngularJS Live Set
AngularJS Live Set example
Real-time apps AngularJS using socket.io
Adding application logic
Working with LoopBack objects
Adding logic to models
Remote methods
Remote hooks
Operation hooks
Model hooks
Connector hooks
Tutorial: Application logic
Defining boot scripts
Defining mixins
Defining middleware
Middleware example
Using current context
Events
Using promises
Running and debugging apps
Setting debug strings
Using strong-error-handler
Preparing for deployment
Running LoopBack apps on Bluemix
LoopBack components
OAuth 2.0 component
Push notification component
Push notifications for iOS apps
Push notifications for Android apps
Storage component
Storage component REST API
Storage component example
Passport login component
Configuring providers.json
Tutorial: third-party login
Synchronization component
Tutorial: Offline Synchronization
Advanced topics - sync
Creating components
Command-line tools
ACL generator
API definition generator
Application generator
Boot script generator
Data source generator
Middleware generator
Model generator
Property generator
Relation generator
Remote method generator
Swagger generator
Refresh definitions command
Client SDKs
iOS SDK
Getting started with the iOS SDK
Android SDK
Getting started with the Android SDK
Working with files using the Android SDK
Push notifications using Android SDK
Working with the LocalInstallation class
AngularJS SDK
Angular example app
AngularJS Grunt plugin
Xamarin SDK
Xamarin client API
Xamarin example app
Isomorphic LoopBack
Running LoopBack in the browser
Using Browserify
Isomorphic example
Connectors reference
Memory connector
Database connectors
Cloudant connector
DashDB
DB2 connector
DB2 for iSeries connector
DB2 for z/OS
Informix connector
MongoDB connector
MongoDB Connector Tutorial
Using MongoLab
MySQL connector
MySQL Connector Tutorial
Oracle connector
Installing the Oracle connector
Oracle connector tutorial
PostgreSQL connector
PostgreSQL connector tutorial
Redis connector
Redis key-value connector
KV connector example
SQL Server connector
SQL Server connector tutorial
SQLite3 connector
Other connectors
Email connector
JSON RPC connector
MQ Light connector
Push connector
Remote connector
Remote connector example
Strong Remoting
REST connector
REST connector example
SOAP connector
SOAP connector example
Storage connector
Swagger connector
Community connectors
Project layout reference
client directory
common directory
Model definition JSON file
package.json
server directory
config.json
datasources.json
middleware.json
model-config.json
server.js
Node reference
LoopBack types
Geopoint type
Valid names in LoopBack
Basic model object
Connected model object
Error object
LoopBack middleware
Publish-subscribe messaging
Strong Pub-sub
Pub-sub bridge
MQTT adapter
Redis pub-sub adapter
Primus pub-sub adapter
Node pub-sub example app
LoopBack pub-sub example app
All tags
This article is for LoopBack 2.x, which is no longer supported. Please see the
corresponding article for 3.x
.
definitions directory
Edit this page
Page Contents
The definitions directory contains YAML files defining an application / API.
app-name.yaml
app-name-product.yaml