MSA वातावरण में कई API दस्तावेज़ों को अपने-आप एकीकृत करना

• MSA वातावरण में service domain की संख्या जितनी हो, उतनी ही API specifications बनने की समस्या होती है
• इस समस्या को हल करने के लिए,
  • MSA वातावरण में अलग-अलग service documents को एक ही URL पर दिखाने, और
  • API document pages को अपने-आप generate करने के तरीके पर विचार
• requirements की परिभाषा और architecture
• API document integration में इस्तेमाल किए गए tools और specs
• API document integration का implementation
  • OpenAPI spec को पूरा करने के लिए basic code work
  • API documents को JSON form में extract करना
  • GitHub Pages से web hosting
  • GitHub Actions का उपयोग करके automation
• multi-repo environment में API document integration लागू करने का तरीका

[elijah17]

इसी तरह की समस्या को हल करने के लिए
हम एक web application बनाकर उसे open source के रूप में जारी कर रहे हैं, जो Swagger API doc को इकट्ठा करता है और उन्हें फिर से Swagger UI में दिखाता है.
https://github.com/stray-cat-developers/giant-otter
अगर किसी को ऐसी ही चिंता है, तो इसे इस्तेमाल करके देखना भी अच्छा रहेगा.