loopbackio / loopbackio/loopback-next

Documentation: Creating and communicating with microservices.

オープン
#6,329 コメント 1 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Docs
主要言語
TypeScript
スター
5.1k
フォーク
1.1k
平均マージ
2日 21時間
マージ済み PR(30日)
27

説明

User Story

There are multiple ways to set up microservices:

  • Have a public facing API Gateway responsible for authentication, that then acts as a proxy for internal microservices, or which can have orchestration logic on top of their responses.
  • Have many public facing services- one responsible for the process of authentication and the frontends are responsible for knowing.

There are also multiple ways to perform communication:

  • Loopback 4 supports creating an OpenAPI JSON based datasource when using lb4 service.
  • HTTP REST
  • rpc, gRPC, redis/socket notifications.

There are different ways to organize the source code:

  • A monorepository, using something like lerna to manage versioning and publishing.
  • Separate repositories managed by different teams.

It would be great to have documentation and examples that could cover these cases. Example:

  • Creating a loopback4 microservice as a REST Server that can expose an openapi.json file, and a loopback4 api gateway responsible for authentication and consuming those microservices.
  • Creating a loopback4 microservice as a gRPC server that can publish proto files (to a private repository, or just on github for consumption), and a loopback4 api gateway responsible for authenticating and consuming those microservices.
  • Workflows for maintaining multiple services with minimal manual code intervention.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、lb4 service と OpenAPI JSON データソースに関する既存の LoopBack 4 ドキュメントを確認します。REST および gRPC マイクロサービス、API ゲートウェイ、認証、サービスの構成、複数サービスのワークフローを対象とする例の範囲を定義します。選択したケースについて完全なドキュメントと実行可能な例が揃っていれば完了としますが、この issue では更新対象のファイルやテストは特定していません。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
grpc, nodejs, openapi, redis, typescript
領域
backend-api-design, distributed-systems, documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。