Day 7 - OpenAPI & Swagger - API Document না করলে team-এর সবাই আপনাকে চিনবে
একটা গল্প share করি। প্রায় ৩-৪ বছর আগের গল্প। তখন আমি fullstack developer হিসেবে কাজ করতাম। তখন একটা project-এর কাজ আসে, existing API already ready + সেটা integration করা লাগবে। Frontend design তো মোটামুটি ঠিকঠাকই ছিল। ঝামেলা বাধে integration করা নিয়ে। আমার যে client ছিল, উনি আমাকে just একটা URL দিয়ে দিলো আর simple একটা body দিয়ে দিলো। তার সামনে try করলাম সুন্দরভাবে কাজ করলো। কিছুক্ষণ পরে আর কাজ…
In a 7th day account, the importance of API documentation is highlighted. A recent project failure demonstrates the consequences of not having proper documentation. API integration issues can delay projects, and without documentation, developers waste valuable time trying to understand how to integrate. OpenAPI Specification (OAS) is recommended as a standard format for API documentation, with YAML or JSON representation of the API.
Swagger UI further enhances documentation by providing a visual representation and the ability to test the API. Code-first and design-first approaches to API development are discussed, with trade-offs between initial velocity, changing fields, prototyping, and stabilizing a public API. Ultimately, the choice between these approaches depends on the specific needs and priorities of the project.
Written by urgent.news from Dev.to's reporting — not their text. Machine-written — may contain errors; check the original before relying on it.