tài liệu API tập trung cho microservices

Question

Nhóm của tôi và tôi hiện đang xây dựng nhiều dịch vụ song song. Chúng tôi có lợi ích của việc xây dựng tất cả các dịch vụ từ đầu. Tôi muốn khả năng tự động hiển thị tất cả các điểm cuối API, từ tất cả các dịch vụ, trong một trang/trang web. Điều này sẽ hữu ích vì (trong số những thứ khác):

1. Tôi không phải truy cập nhiều trang tài liệu để xem điểm cuối có sẵn trong toàn bộ "hệ thống" của mình là gì.

2. Đây sẽ là bước đầu tiên tốt để xác định xem có bất kỳ dịch vụ nào nên được tách, kết hợp hoặc đơn giản được cấu trúc lại hay không.

Một số dịch vụ của chúng tôi ở Django và mô-đun rest-swagger là một trợ giúp tuyệt vời. Nhưng tôi không thấy làm thế nào tôi có thể kết hợp tài liệu còn lại vênh vang từ nhiều dịch vụ thành một trang tài liệu/trang web duy nhất.

Tôi hiện đang xem qua this site và mọi thứ liên quan đến Netflix experience nhưng không thể tìm thấy giải pháp cho vấn đề của tôi. Có thể tài liệu tập trung không phải là vấn đề lớn với 600+ dịch vụ tại Netflix, nhưng điều đó khó tin.

Ai đó có thể đề xuất một công cụ hoặc phương pháp để có tài liệu API kết hợp cho tất cả các dịch vụ trong kiến ​​trúc microservice không?

kịch bản lý tưởng của tôi về những gì sẽ xảy ra khi một dịch vụ được thay đổi:

1. tôi bấm vào liên kết để xem danh sách các thiết bị đầu cuối trong hệ thống của tôi.
2. Một đồng đội cập nhật một dịch vụ và cũng là tài liệu của nó.
3. Tôi làm mới trang hiện tại và tôi thấy thay đổi đó được thực hiện từ bướC# 2.

Answer 1

Với điểm kinh nghiệm của tôi, bạn có một số đường dẫn.

1. http://readme.io/
2. Thực hiện một wiki với JIRA, Redmine.
3. Trong Github tạo một repo cho các tài liệu độc quyền.
4. Google Documents.

Answer 2

Tôi không biết về bất kỳ công cụ hiện có nào thay vì tôi chỉ đang nghĩ đến nơi cần làm.

Từ những gì OP mô tả, họ đã xây dựng kiến ​​trúc dịch vụ vi mô bằng cách sử dụng chồng Netflix. Nên có một kho lưu trữ để cấu hình tên (hoặc URL) cho mỗi dịch vụ và 'máy chủ cấu hình' hoặc 'đăng ký dịch vụ' sẽ đọc từ đó. Với tôi, đó là nơi hoàn hảo để đưa tham chiếu đến từng tài liệu của dịch vụ vi mô dưới mục nhập của riêng họ. Bằng cách này, bạn có được lợi ích của việc duy trì tài liệu và mã tại cùng một vị trí, cộng với bạn có khả năng cũng có thể thu thập thông tin thời gian chạy như thể hiện/kết nối đếm nếu bạn móc vào máy chủ cấu hình/đăng ký.

Answer 3

Đang trong tình huống tương tự Tôi đang tìm cách áp dụng https://readthedocs.org/ với GIT được hỗ trợ.