loopbackio / loopbackio/loopback-next
Documentation: Creating and communicating with microservices.
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 5.1k
- Forks
- 1.1k
- Ø Merge
- 2 T. 21 Std.
- Gemergte PRs (30 T.)
- 27
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der Durchsicht der vorhandenen LoopBack-4-Dokumentation zu `lb4 service` und OpenAPI-JSON-Datenquellen. Legen Sie den Umfang für Beispiele zu REST- und gRPC-Microservices, API-Gateways, Authentifizierung, der Organisation von Services und Workflows mit mehreren Services fest. Als abgeschlossen gilt die Aufgabe, wenn die ausgewählten Fälle vollständig dokumentiert sind und ausführbare Beispiele enthalten; das Issue nennt jedoch keine zu aktualisierenden Dateien oder Tests.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- grpc, nodejs, openapi, redis, typescript
- Bereich
- backend-api-design, distributed-systems, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100