loopbackio / loopbackio/loopback-next

Documentation: Creating and communicating with microservices.

Abierto
#6,329 1 comentario 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Docs
Lenguaje dominante
TypeScript
Estrellas
5.1k
Forks
1.1k
Merge medio
2 d 21 h
PR fusionados (30 d)
27

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando la documentación existente de LoopBack 4 sobre `lb4 service` y las fuentes de datos JSON de OpenAPI. Define el alcance de los ejemplos que cubran microservicios REST y gRPC, API gateways, autenticación, organización de servicios y flujos de trabajo con múltiples servicios. La tarea se considera completada cuando los casos seleccionados tienen documentación completa y ejemplos ejecutables, pero el issue no identifica archivos ni pruebas que deban actualizarse.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
grpc, nodejs, openapi, redis, typescript
Área
backend-api-design, distributed-systems, documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.