API docs
The complete API documentation platform
Create detailed, interactive API docs your users and customers will love — or generate them automatically from API definition files
Instant API code samples in the right language
API documentation in GitBook gives your users a ton of information at a glance. And because it automatically generates code samples for API endpoints, it’s easy for everyone to find and use the information and code they need.
Add context around your API operations
Organize your docs however you want. Group related operations together, or split them into different pages. Add an introduction, interactive guides, and any other content that will help your users. You have complete control.
Test your APIs right in GitBook
Let users and developers try API endpoints right on the page with our OpenAPI blocks powered by Scalar. Simply click Test It to open up an API client where you can add headers, variables and more — then run a live test.
API documentation for all kinds of products
git Sync
Update your API docs through your codebase
With our GitHub Sync and GitLab Sync integrations, you can set up a two-way sync with your codebase. Now, when you make changes to your API, you can update your API docs at the same time — right in GitHub or GitLab.
Documentation your users will love
Customize and brand your API documentation
Change colors, add your own logo, and choose how things appear on every page. API docs in GitBook look great out of the box, but if you want to add some flair, it’s easy.
Protect access for only authorized users
Choose who gets access to your API documentation with visitor authentication. Keep sensitive information private, so only your chosen customers, team members or authorized users can view your docs.
