Md Akram Hossain

The API Docs frontend uses a three-column layout designed for developer readability. UX principle: Left = Navigate → Center = Understand → Right = Implement Left Sidebar — Navigate Center Column — Understand Displays the full structured documentation for the…

Each API Doc can display its content in one of two modes. This is set per-doc in the General tab under Display Format, or site-wide in Settings. One-Page Mode (onepage) All collections and all endpoints are rendered on a single…

Each endpoint has a Details panel (tabbed inside the collection group) with four categories of structured information: Parameters, Request, Responses, and Code Examples. Parameters Tab Parameters describe the inputs an endpoint accepts. Field Description Options Name Parameter name as used…

Collections are the grouping layer in an API Doc. Think of them as folders that organize related endpoints together. Every endpoint belongs to exactly one collection. Example Structure Managing Collections The Collections section of the editor uses a drag-and-drop group…

The General tab contains the top-level settings for the entire API Doc. These fields apply to the whole project, not to individual endpoints. General Tab Fields Field Description Example Description Overview text shown at the top of the API Doc…