ระบบงานต่าง ๆ นั้น ยิ่งนานไประบบยิ่งมีส่วนการทำงานต่าง ๆ เยอะขึ้น ซับซ้อนมากขึ้นทั้ง product, domain, service และ messaging ต่าง ๆ ดังนั้นเราจะจัดการสิ่งต่าง ๆ เหล่านี้อย่างไรเพื่อให้เรารู้และเข้าใจภาพรวมของระบบมากยิ่งขึ้นสามารถ maintain ได้ง่าย สามารถหาได้ง่าย ทีมต่าง ๆ ทำงานร่วมกันได้ดีขึ้นรวมทั้งวิเคราะห์ผลกระทบต่าง ๆ จากการแก้ไขได้ดีขึ้นเราจะทำอย่างไรดี
เนื่องจากมีปัญหาในจัดการ OpenAPI หรือ Swagger ที่คุ้นเคยใน FastAPI กันดังนี้ เลยลองมาทำดูแบบง่ายกันหน่อย
มีโอกาสแบ่งปันประสบการณ์เรื่องของ API-First development (Design-First)ซึ่งจะตรงข้ามกับ Code-First ที่มักจะมีขั้นตอนการทำงานดังนี้ แต่แนวทางของ API-First development จะแตกต่างออกไปดังนี้
วันนี้ได้พูดคุยใน ClubHouse กันนิดหน่อย เรื่อง Swagger/Protobuf usecase and trendเป็นการแลกเปลี่ยนแนวทางในการพัฒนา API ไม่ว่าจะเป็น RESTFul API, Protobuf หรือพวก gRPC แนวทางในการพูดคุยประกอบไปด้วย
จากบทความเรื่อง รวม Tips & Tricksในการสร้าง Swagger UI ให้กับ Gin REST API ด้วย Swaggoอธิบายถึงการสร้าง API Documentationโดยทำการสร้างมาจาก Code Annotation ในส่วนของ comment ด้วย command swagซึ่งเป็นแนวทางหนึ่งในการสร้างเอกสารขึ้นมา แต่ก็ยังไม่แนวทางอื่น ๆ ใช้งานเช่นกัน
สำหรับใครที่ต้องออกแบบและจัดการ Open API หรือ Swagger แล้ว ใน VS Code นั้นมี extension ชื่อว่า OpenAPI (Swagger) Editor ให้ใช้งาน แน่นอนว่า ทำให้การทำงานง่ายและสะดวกขึ้น
วันนี้มีโอกาสได้แบ่งปันความรู้สำหรับการสร้าง API ด้วยภาษา Python โดยสิ่งที่ต้องการคือ พัฒนาได้ง่าย ยิ่งถ้าสร้างจาก specification บางอย่างด้วยน่าจะดี ขนาดไม่ใหญ่ ไม่ซับซ้อน ดังนั้นจึงเลือก Flask ซึ่งเป็น microframework สำหรับการพัฒนาระบบ web รวมทั้งใช้ Connexion เพื่อช่วยทำการสร้าง API แบบอัตโนมัติ จากการกำหนดค่าต่าง ๆ ในรูปแบบ OpenAPI หรือ Swagger Specification นั่นเอง ซึ่งน่าจะเป็นทางเลือกที่น่าสนใจ มาลองใช้งานกัน