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 4
Overview
Getting started
Inside a LoopBack Application
Building LoopBack Applications
Tutorials
Todo Tutorial
Create your app scaffolding
Add the Todo model
Add a Datasource
Add a Repository
Add a Controller
Putting it all together
Bonus: Integrate with a geo-coding service
TodoList Tutorial
Add TodoList Model
Add TodoList Repository
Add Model Relations
Add a HasOne Relation
Add TodoList Controller
Running on relational databases
Connecting to Back-end Service Tutorials
SOAP Web Service Tutorial
SOAP Web Service Overview
App scaffolding
Add a Datasource
Add a Service
Add a Controller
Run and Test it
Creating an Express Application with LoopBack REST API
How to secure your LoopBack 4 application with JWT authentication
Build large scale Node.js projects with LoopBack 4
Introduction of the application scenario
Architectural challenges
Context in action
Dependency injection
Extension point and extensions
Interception
Observation of life cycle events
Configuration
Discover and load artifacts by convention
Advanced Recipes
Summary
Examples
Community examples
How-to guides
Building REST APIs
Creating CRUD REST APIs from a model
Customizing how OpenAPI spec is served
Customizing routes
Dynamically adding models, repositories, and controllers
Self-hosted REST API Explorer
Serving Static Files
Accessing HTTP Request and Response Objects
Uploading and Downloading Files
Using Express Middleware
Using strong-error-handler
Boot and Mount a LoopBack 3 Application
Integrating with API Connect
Accepting MessagePack over HTTP
Creating Other Forms of APIs
Creating GraphQL APIs
Using OpenAPI-to-GraphQL
Creating Artifacts at Runtime
Creating Model at Runtime
Creating DataSource at Runtime
Creating Repositories at Runtime
Building frontend applications
Building an Angular Application from OpenAPI Specification
Customizing Server configuration
Migrate from Legacy Sequence
Running cron jobs
Accessing Databases
Configuring DataSource
Working with data
Querying data
Fields filter
Include filter
Limit filter
Order filter
Skip filter
Where filter
Using Database Transactions
Database Migrations
Executing database commands
Using Sequelize
How to use Sequelize with LoopBack
Using TypeORM
How to use TypeORM with LoopBack
Accessing Services
Calling SOAP Web services
Calling REST APIs
Parsing requests
Validating Data
Validation in REST Layer
Validation in the Controller, Repository and Service Layer
Validation in ORM Layer
Configuring Applications
Tips for Application Setup
Securing Applications
Authentication
Apply JWT Authentication in Todo Example
Authentication Component
Authentication Decorator
Authentication Action
Authentication Strategy
Managing Custom Authentication Strategy Options
JWT Authentication Extension
Implement your own authentication strategy
Passport Adapter for Authentication
Authorization
RBAC with Authorization System
Authorization Component
Interceptor
Decorator
Authorizer
Decision Matrix
Enforcer
Deploying Applications
Enabling HTTPS
Deploying to IBM Cloud
Deploying to Kubernetes on IBM Cloud
Deploying with pm2 and nginx
Developing and Deploying LoopBack Applications with Appsody
Running cron jobs
Health check
Metrics for Prometheus
Pooling
Troubleshooting
Setting debug strings
Logging
Context Explorer
Debugging tests with Mocha
Extending LoopBack Framework
How-to guides
Creating components
Creating decorators
Contributing REST API
Creating services
Creating servers
Extending request body parsing
Extension life cycle
Extending OpenAPI specification
Extending Model API builder
Testing your extension
Community extensions
Concepts
Crafting LoopBack 4
Core
Application
Component
Context
Binding
Dependency Injection
Interceptor
Life Cycle Event and Observer
Extension point and extensions
Service
Booter
Decorators
OpenAPI Decorators
Dependency Injection Decorator
Authentication Decorator
Authorization Decorators
Service Decorators
Repository Decorators
Mixin
REST APIs
Server
Sequence
Middleware based sequence
Action based sequence
Advanced topics
Routing requests
Parsing requests
Working with Express Middleware
Middleware
Route
Controller
Request/response cycle
Data Access
Model
Relations
HasMany Relation
BelongsTo Relation
HasOne Relation
HasManyThrough Relation
ReferencesMany Relation
Polymorphic Relation
Repository
DataSource
Best practices
Defining the API using code-first approach
Defining your testing strategy
Testing your application
Reference guides
LoopBack 4 Application Layout
API docs
Reserved binding keys
Error codes
LoopBack Types
CLI References
Application generator
Controller generator
DataSource generator
Import models from LoopBack 3
Model generator
Model discovery
Relation generator
Repository generator
REST CRUD model endpoints generator
Service generator
OpenAPI generator
Life cycle observer generator
Interceptor generator
Extension generator
Download examples
Update project dependencies
Generate copyright/license headers
Connectors reference
Memory connector
Database connectors
Cassandra connector
Cloudant connector
CouchDB 2.x connector
DashDB connector
IBM Db2 (for Linux, Unix, Windows) connector
IBM Db2 for i connector
IBM Db2 for z/OS connector
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
z/OS Connect Enterprise Edition connector
Other connectors
JSON RPC connector
MQ Light connector
REST connector
REST connector example
SOAP connector
Strong-soap
SOAP connector example
Connecting to SOAP web services
OpenAPI connector
Community connectors
Change logs
Considerations for GDPR readiness
Contributing to LoopBack 4
Submitting a pull request to LoopBack 4
FAQ
Migration guide
Understanding the differences
Booting process
Request/response cycle
Mounting a LoopBack 3 application
Express middleware
Datasources
Migrating models
Model definitions and built-in APIs
Relations
Custom methods
Remoting hooks
CRUD operation hooks
Mixins
Boot scripts
Authentication & authorization
Access control example
Built-in models and authentication
Passport
OAuth2 Provider
CLI
Components and extensions
Project layout
Models
Current context
Mixins
REST API
Clients (API consumers)
Features not planned
API docs: openapi-v3.restendpoint.spec
Source code
Page Contents
Home
>
@loopback/openapi-v3
>
RestEndpoint
>
spec
RestEndpoint.spec property
Signature:
spec
?:
OperationObject
;