DOCSEARCHbyAlgolia
Submit Docs

LoopBack Documentation

website·Indexed 38 days ago

https://loopback.io/doc/

Documentation for the LoopBack framework, including API references for @loopback/rest, guides for lb3 and lb4, and connector tutorials for MongoDB, Oracle, and Microsoft SQL Server. Includes security advisories, troubleshooting guides, and getting started instructions for building APIs with Node.js.

Tokens
1.2M
Snippets
7K
Records
9.9K
Agent score
67%

What's inside LoopBack

  1. Overview of LoopBack model mixins

    Mixins allow developers to apply common logic to a set of models. They can be used to inject properties into model definitions or observe changes using operation hooks. Mixins can be applied to any model, including built-in models.

  2. Overview of @loopback/repository-tests

    The @loopback/repository-tests package provides a standardized test suite to verify the functionality of @loopback/repository in a connector-independent manner. It allows developers to test any combination of a Repository class (such as DefaultCrudRepository) and a corresponding connector (such as memory, MySQL, or MongoDB) to ensure consistent behavior across different data sources.

  3. Overview of OpenAPI-to-GraphQL functionality

    OpenAPI-to-GraphQL allows developers to take any OpenAPI Specification (OAS) and automatically create a GraphQL interface. It provides several key capabilities:

    • Nested Data Support: It uses OAS schemas to create GraphQL data definitions and utilizes links defined in the OAS to enable deeply nested queries.
    • API Sanitation: The tool automatically sanitizes identifiers that are incompatible with GraphQL. Parameters or data definitions containing unsupported characters (such as -, ., ,, :, ;) are removed to ensure GraphQL compatibility.
    • Authentication: It provides viewers to support passing basic authentication credentials or API keys. For OAuth 2.0 integration, the hosting application must handle the implementation.

  4. Overview of LoopBack 3 Model Mixins

    Mixins in LoopBack 3 allow developers to apply common logic to a set of models. They can be used to inject properties (like timestamps) or observe model changes using operation hooks. Mixins can be applied to any model, including built-in models.

  5. Overview of LoopBack 4 Framework

    LoopBack 4 is a highly extensible Node.js and TypeScript framework designed for building APIs and microservices. It features a core written in TypeScript/ES2017 and utilizes an OpenAPI specification-driven approach for creating REST APIs. The framework implements a modern programming model that includes Dependency Injection, Components, Mixins, and Repositories to maximize extensibility.

  7. Overview of LoopBack Connectors

    LoopBack connectors implement the data exchange logic required to communicate with backend systems. They allow LoopBack to interact with relational databases, NoSQL databases, REST APIs, and SOAP APIs. Connectors are categorized into built-in (such as the memory connector for local development), database connectors, other API-based connectors, and community-maintained connectors.

  8. Overview of @loopback/metadata

    The @loopback/metadata module provides utilities for implementing TypeScript decorators, defining and merging metadata, and inspecting that metadata. It consists of three primary components:

    • Reflector: A wrapper around reflect-metadata.
    • Decorator factories: Tools to create class, method, property, and parameter decorators.
    • MetadataInspector: High-level APIs to retrieve metadata applied to classes and their members.

  9. Overview of the LoopBack Framework

    LoopBack is an open-source Node.js framework designed for creating dynamic end-to-end REST APIs with minimal coding. It provides capabilities to access data from relational databases, MongoDB, SOAP, and REST APIs, and supports model relationships, access controls, file storage components, third-party login, and OAuth 2.0.

  10. Overview of StrongLoop strong-pubsub messaging

    strong-pubsub is a library of modules implementing the publish-subscribe programming model. It is designed to be transport-agnostic and protocol-agnostic, allowing developers to swap out underlying adapters (e.g., MQTT, Redis) and transports (e.g., TCP, TLS, WebSockets, Primus) without changing the core application logic. Note: As of the current documentation, these modules are pre-version 1.0 and the API may change.

  11. Overview of Dependency Injection in LoopBack 4

    Dependency Injection (DI) in LoopBack 4 separates the construction of a class or function's dependencies from its behavior to ensure loose coupling. This allows developers to easily rewire dependencies for customization or inject mocks and stubs for unit testing, especially when dealing with external services like databases or OAuth2 providers. The @loopback/core package re-exports all public APIs of @loopback/context; using @loopback/core for imports is recommended for consistency.

  12. Overview of the LoopBack Framework

    LoopBack is a highly extensible open-source Node.js framework designed to create dynamic end-to-end REST APIs with minimal or no coding. It allows developers to:

    • Access data from relational databases, MongoDB, SOAP, and REST APIs.
    • Implement relationship models and access control for complex APIs.
    • Utilize built-in push, geolocation, and file services for mobile applications.
    • Build client applications for Android, iOS, and JavaScript SDKs.
    • Deploy applications locally or in cloud services.