loopbackio / loopbackio/loopback-next

Documentation: Creating and communicating with microservices.

Đang mở
#6,329 1 bình luận 3 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Docs
Ngôn ngữ chính
TypeScript
Star
5.1k
Fork
1.1k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
27

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng việc xem lại tài liệu LoopBack 4 hiện có về lb4 service và các datasource JSON của OpenAPI. Xác định phạm vi cho các ví dụ bao quát microservice REST và gRPC, API gateway, xác thực, tổ chức dịch vụ và workflow nhiều dịch vụ. Công việc được xem là hoàn tất khi các trường hợp được chọn có tài liệu đầy đủ và các ví dụ có thể chạy được, nhưng issue không xác định các tệp hoặc kiểm thử cần cập nhật.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
grpc, nodejs, openapi, redis, typescript
Lĩnh vực
backend-api-design, distributed-systems, documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.