Mikroservisler için merkezi API belgeleri

Question

Ekibim ve ben şu anda paralel olarak birden çok hizmet kuruyoruz. Tüm hizmetleri sıfırdan oluşturmanın avantajına sahibiz. Tüm servis noktalarından tüm API uç noktalarını tek bir sayfada/sitede otomatik olarak görüntüleme yeteneğini isterim. Bunun nedeni (diğer şeyler arasında) yararlı olacaktır: benim bütün "sistem" mevcut bitiş noktaları nelerdir görmek için birden dokümantasyon sitelerine gitmek gerekmez

1. .

2. Hizmetlerden herhangi birinin bölünmesi, birleştirilmesi veya basit bir şekilde yeniden oluşturulmasının gerekip gerekmediğini belirlemek için iyi bir ilk adım olacaktır. Hizmetlerimizin

Bazı Django olan ve rest-swagger modül harika bir yardımcı. Ancak, birden fazla hizmetin geri kalanı yağmalanan belgelerini tek bir dokümantasyon sayfası/sitesinde nasıl birleştirebileceğimi göremiyorum.

Şu anda this site ve Netflix experience ile ilgili bir şey arıyorum, fakat benim sorunum için bir çözüm bulamadık. Belki de merkezi dokümantasyon Netflix'te 600'den fazla hizmetle büyük bir anlaşma değil, ancak buna inanmak zor.

Herkes, bir microservice mimarisindeki tüm hizmetler için birleştirilmiş bir API belgelerine sahip olmak için bir araç veya yöntem önerebilir mi? Bir servis değiştirildiğinde ne olur

Benim ideal senaryo:

1. benim sistemdeki uç noktaları listesini görmek için linke tıklayın.
2. Takım arkadaşı, bir hizmeti ve ayrıca belgeleri de güncelleştirir.
3. Şu anda bulunduğum sayfayı yeniliyorum ve 2. adımdan itibaren bu değişikliği görüyorum.

Answer 1

Ekspresimle, bazı yollarınız var.

1. http://readme.io/

2. JIRA, Redmine ile wiki olun.
3. Github'da özel dokümanlar için bir repo oluşturun.
4. Google Dokümanlar.

Answer 2

Var olan herhangi bir araç hakkında bir bilgim yok, sadece düşüncemi nerede yapacağım üzerine koyuyorum.

OP açıkladığından, Netflix yığını kullanarak zaten bir mikro hizmetler mimarisi oluşturuyorlar. Hizmetlerin her birinin adını (veya URL'sini) yapılandırmak için bir depo olmalı ve 'config server' veya 'servis kaydı' bundan okuyacaktır. Bana göre, bu, mikro servisin belgelerinin her birine kendi girişleri altında referans vermek için mükemmel bir yer. Bu şekilde, belgeleri ve kodları aynı yerde tutmanın yararlarından yararlanırsınız, ayrıca yapılandırma/kayıt sunucusuna bağlanırsanız örnek/bağlantı sayısı gibi çalışma zamanı bilgilerini de toplayabilirsiniz.

Answer 3

Benzer bir durumda GIT destekli https://readthedocs.org/'u benimsemek istiyorum.