How to Write OpenAPI-Compliant and Swagger UI-Testable API Documentation
Jan 20 · 12 min read · Article Objective At the end of this article, the reader should be equipped with the knowledge of writing well-structured and clear API documentation that is OpenAPI-compliant and fully testable in Swagger UI. Article Outline Introduction Prerequis...
Join discussion
Why Automate Your API Documentation: Time-Saving and Scale
Nov 27, 2025 · 2 min read · You just pushed a new API update and closed your laptop, feeling a bit relieved. Then it hits you. The documentation isn’t updated. Somewhere in that Markdown file, an old endpoint is still sitting there. A new one is missing. You’ll need to revise i...
Join discussion
API Docs for AI Agents 📝
Nov 20, 2025 · 6 min read · 1. Why the Focus is Shifting to AI Documentation The rise of sophisticated AI systems and large language models (LLMs) is fundamentally changing how software uses APIs. Technical documentation is no longer just a manual for developers but an instruct...
Join discussion
A Day One Understanding of APIs, SDKs, And API Documentation
Nov 5, 2025 · 2 min read · For someone just getting into the world of developers, APIs, and SDKs, this piece explains things simply without being too overwhelming. What is an API? API stands for Application Programming Interface. It is the middleperson that helps two applicati...
Join discussionOKX API Documentation Guide 2025: Master Every Feature
Oct 19, 2025 · 9 min read · In the fast‑evolving world of digital assets, developers and traders alike need a reliable gateway to market data, order execution, and account management. The OKX API documentation has become one of the most comprehensive toolkits available for buil...
Join discussion
Write Your First OpenAPI: A Step-by-Step Guide for Beginners
Sep 9, 2025 · 4 min read · Imagine this. You open a restaurant menu. Each dish has a name, a description, the ingredients you need, and what the final plate looks like. OpenAPI works the same way for APIs. It is the menu card that tells developers what is available, what to se...
Join discussion
API Live Sync #2: Live Source Data Structures and Types
Aug 13, 2025 · 7 min read · In this second post, I’ll delve into creating the structures and foundations that we can build upon later to fully implement live-sync. You can find the repository here. The Mission: Eliminating Manual API Documentation Just so we don’t lose sight o...
Join discussion
Week 10: The quest for module independence!
Aug 10, 2025 · 4 min read · 📅 August 04 – August 10 What I Planned to Do To fix the introspector bug and come up with an enhanced and watertight version with robust property introspection To move forward with generating openAPI specs for the search handlers and RepHandlers ...
Join discussion
Markdown in 2025: Why It's Still Winning the Publishing Game
May 4, 2025 · 2 min read · “Markdown isn’t dead. In fact, it’s quietly running the internet.” We’re in 2025. AI tools are writing docs, Notion is the new Word, and rich editors are everywhere.And yet—Markdown is still a powerhouse. If you're a developer, writer, note-taker, o...
Join discussion