falcor README

The project's README from github.com/Netflix/falcor. As one markdown file: README.md.

Falcor

Build Status Coverage Status

2.0

2.0 is the current stable Falcor release. 0.x and 1.x users are welcome to upgrade.

Roadmap

Issues we're tracking as part of our roadmap are tagged with the roadmap label. They are split into enhancement, stability, performance, tooling, infrastructure and documentation categories, with near, medium and longer term labels to convey a broader sense of the order in which we plan to approach them.

Getting Started

You can check out a working example server for Netflix-like application right now. Alternately, you can go through this barebones tutorial in which we use the Falcor Router to create a Virtual JSON resource. In this tutorial we will use Falcor's express middleware to serve the Virtual JSON resource on an application server at the URL /model.json. We will also host a static web page on the same server which retrieves data from the Virtual JSON resource.

Creating a Virtual JSON Resource

In this example we will use the falcor Router to build a Virtual JSON resource on an app server and host it at /model.json. The JSON resource will contain the following contents:

{
  "greeting": "Hello World"
}

Normally, Routers retrieve the data for their Virtual JSON resource from backend datastores or other web services on-demand. However, in this simple tutorial, the Router will simply return static data for a single key.

First we create a folder for our application server.

$ mkdir falcor-app-server
$ cd falcor-app-server
$ npm init

Now we install the falcor Router.

$ npm install falcor-router --save

Then install express and falcor-express. Support for restify is also available, as is support for hapi via a third-party implementation.

$ npm install express --save
$ npm install falcor-express --save

Now we create an index.js file with the following contents:

// index.js
const falcorExpress = require("falcor-express");
const Router = require("falcor-router");

const express = require("express");
const app = express();

app.use(
    "/model.json",
    falcorExpress.dataSourceRoute(function (req, res) {
        // create a Virtual JSON resource with single key ('greeting')
        return new Router([
            {
                // match a request for the key 'greeting'
                route: "greeting",
                // respond with a PathValue with the value of 'Hello World.'
                get: () => ({ path: ["greeting"], value: "Hello World" }),
            },
        ]);
    })
);

// serve static files from current directory
app.use(express.static(__dirname + "/"));

app.listen(3000);

Now we run the server, which will listen on port 3000 for requests for /model.json.

$ node index.js

Retrieving Data from the Virtual JSON resource

Now that we've built a simple virtual JSON document with a single read-only key greeting, we will create a test web page and retrieve this key from the server.

Create an index.html file with the following contents:

<!-- index.html -->
<html>
    <head>
        <!-- Do _not_  rely on this URL in production. Use only during development.  -->
        <script src="https://netflix.github.io/falcor/build/falcor.browser.js"></script>
        <!-- For production use. -->
        <!-- <script src="https://cdn.jsdelivr.net/falcor/{VERSION}/falcor.browser.min.js"></script> -->
        <script>
            var model = falcor({
                source: new falcor.HttpDataSource("/model.json"),
            });

            // retrieve the "greeting" key from the root of the Virtual JSON resource
            model.get("greeting").then(function (response) {
                document.write(response.json.greeting);
            });
        </script>
    </head>
    <body></body>
</html>

Now visit http://localhost:3000/index.html and you should see the message retrieved from the server:

Hello World

Steps to publish new version

Additional Resources

falcor (Netflix/falcor)

Searching Database…

10.6K ·GitHub
Falcor
Что это?Falcor — это JavaScript-библиотека от Netflix для эффективной загрузки данных. Она позволяет описать все данные бэкенда как один виртуальный JSON-граф, который клиент может запрашивать по частям, вместо того чтобы работать с множеством REST-эндпоинтов.
Это клиентская библиотека, серверный фреймворк или и то и другое?Это библиотека, которая используется с обеих сторон: Model API на клиенте для запросов к JSON Graph и Router на сервере (с промежуточным ПО для Express/Hapi/Restify), который превращает этот виртуальный JSON в реальные данные.
Как мне запустить базовый сервер и клиент Falcor?Установите falcor Router, express и falcor-express, напишите index.js, который создаёт Router и отдаёт его по адресу /model.json, а затем создайте index.html, в котором Falcor Model запрашивает ключи с этого эндпоинта по HTTP.
Что оно использует под капотом?Сама библиотека зависит от falcor-json-graph, falcor-path-syntax, falcor-path-utils и symbol-observable, а в типичных настройках для серверного транспорта добавляются express (или hapi/restify) и falcor-express.
Есть ли подводные камни при обновлении или внедрении?Между версиями 0.x, 1.x и текущим релизом 2.0 есть несовместимые изменения, поэтому при переходе между основными версиями нужно сверяться с журналом изменений, а не просто заменять пакет.
Для кого это?Это для JavaScript/Node-разработчиков на бэкенде и фронтенде, которые создают приложения с большим объёмом данных (вроде собственного интерфейса Netflix) и хотят иметь одну единую модель данных вместо множества самописных REST-вызовов.
Что такое JSON Graph?JSON Graph — это модель виртуального JSON-документа, которую Falcor использует для представления всего удалённого набора данных приложения. Router формирует его по запросу из хранилищ бэкенда или других сервисов.
Как Falcor решает проблему избыточной выборки данных в REST?Вместо фиксированных эндпоинтов клиенты запрашивают конкретные пути в общем JSON Graph, а Router обрабатывает только эти пути. Поэтому ответы содержат именно нужные данные и требуют как можно меньше обращений к серверу.
Где посмотреть рабочий пример?Есть готовый пример сервера, созданный по образцу приложения в духе Netflix, а также отдельный falcor-router-demo, который показывает Router в действии.
Где задать вопросы о Falcor?В README пользователей направляют на Stack Overflow для вопросов и обсуждений.
What are similar projects?express, koa, pollyjs, multer, node-restify, ky, fiber, pino
Which topics is it in?express, http, json, rest-api, backend, npm, frontend, api, apache-2.0, server, nodejs, library
Creator
Netflix
Size
23.1 MB
Stars
10.6K
Updated
CommitAug 28
Age
11y
Commits · 90 Days