loopbackio / loopbackio/loopback-next

Documentation: Creating and communicating with microservices.

Ouverte
#6,329 1 commentaire 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Docs
Langage dominant
TypeScript
Étoiles
5.1k
Forks
1.1k
Merge moyen
2 j 21 h
PR mergées (30 j)
27

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner la documentation existante de LoopBack 4 concernant lb4 service et les sources de données JSON OpenAPI. Définissez le périmètre des exemples couvrant les microservices REST et gRPC, les API gateways, l’authentification, l’organisation des services et les workflows multi-services. La tâche est considérée comme terminée lorsque les cas sélectionnés disposent d’une documentation complète et d’exemples exécutables, mais l’issue n’identifie pas les fichiers ou les tests à mettre à jour.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
grpc, nodejs, openapi, redis, typescript
Domaine
backend-api-design, distributed-systems, documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.