-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[docs] Adopt four-quadrant documentation system #5718
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,75 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Components' | ||
| keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI | ||
| title: 'Behind the scenes' | ||
| keywords: LoopBack 4, Node.js, TypeScript, OpenAPI, Explanations, Concepts | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/Behind-the-scene.html | ||
| --- | ||
|
|
||
| LoopBack 4 defines some key building blocks to represent different | ||
| responsibilities for typical API and/or Microservice applications. | ||
|
|
||
|  | ||
|
|
||
| - [**Application**](Application.md): The central class for setting up all of | ||
| your module’s components, controllers, servers and bindings. The Application | ||
| class extends [Context](Context.md) and provides the controls for starting and | ||
| stopping its associated servers. | ||
|
|
||
| - [**Server**](Server.md): An implementation for inbound transports/protocols | ||
| such as REST (http, https), gRPC (http2) and graphQL (http, https). It | ||
| typically listens on a specific endpoint (protocol/host/port), handles | ||
| incoming requests, and then returns appropriate responses. | ||
|
|
||
| - [**Controller**](Controllers.md): A class that implements operations defined | ||
| by the application’s REST API. It implements an application’s business logic | ||
| and acts as a bridge between the HTTP/REST API and domain/database models. A | ||
| Controller operates only on processed input and abstractions of backend | ||
| services / databases. | ||
|
|
||
| - [**Interceptors**](Interceptors.md): A function that intercepts static or | ||
| instance method invocations on a class or object. | ||
|
|
||
| - [**Route**](Routes.md): The mapping between your API specification and an | ||
| Operation. It tells LoopBack which Operation to `invoke()` when given an HTTP | ||
| request. | ||
|
|
||
| - [**Sequence**](Sequence.md): A stateless grouping of | ||
| [Actions](Sequence.md#actions) that control how a Server responds to requests. | ||
|
|
||
| - [**Model**](Model.md): The definition of an object in respect to the | ||
| datasource juggler. The `@loopback/repository` module provides special | ||
| decorators for adding metadata to TypeScript/JavaScript classes to use them | ||
| with the legacy implementation of DataSource Juggler. In addition, | ||
| `@loopback/repository-json-schema` module uses the decorators' metadata to | ||
| build a matching JSON Schema. | ||
|
|
||
| - [**DataSources**](DataSources.md): A named configuration for a Connector | ||
| instance that represents data in an external system. | ||
|
|
||
| - [**Repository**](Repositories.md): A type of service that represents a | ||
| collection of data within a DataSource. | ||
|
|
||
| - [**Relation**](Relations.md): A mapping between two models which describes a | ||
| real world link between them and exposes CRUD APIs based on the configuration. | ||
|
|
||
| - [**Decorator**](Decorators.md): The pattern used to annotate or modify your | ||
| class declarations and their members with metadata. | ||
|
|
||
| Here are the infrastructures that get all the artifacts working together: | ||
|
|
||
| - [Context](Context.md): An abstraction of states and dependencies in your | ||
| - [**Context**](Context.md): An abstraction of states and dependencies in your | ||
| application that LoopBack uses to manage everything. It’s a global registry | ||
| for everything in your app (configurations, state, dependencies, classes and | ||
| so on). | ||
| - [Binding](Binding.md): An abstraction of items managed by a context. Each | ||
|
|
||
| - [**Binding**](Binding.md): An abstraction of items managed by a context. Each | ||
| binding has a unique key within the context and a value provider to resolve | ||
| the key to a value. | ||
| - [Dependency Injection](Dependency-injection.md): The technique used to | ||
|
|
||
| - [**Dependency Injection**](Dependency-injection.md): The technique used to | ||
| separate the construction of dependencies of a class or function from its | ||
| behavior to keep the code loosely coupled. | ||
| - [Component](Components.md): A package that bundles one or more LoopBack | ||
|
|
||
| - [**Component**](Components.md): A package that bundles one or more LoopBack | ||
| extensions. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.