Transform Your OpenAPI Spec into Interactive, AI-Powered Documentation with GitBook

Tal Gluck, GitBook

Welcome! Today we're going to set up a docs site with GitBook that contains both product docs and auto-updating API docs.

You'll learn how to quickly get up-and-running with a GitBook docs site, customize that site, add an OpenAPI spec, build and customize docs from that spec, and use the GitBook AI Assistant to ask questions about your docs and API.

Here are the steps:

1. Fork this repo (use your personal org instead of a company one to keep permissions easy for now)
2. Sign up for GitBook
3. Create your GitBook org and site
4. Set up Git Sync with your newly forked repo (under Monorepo, specify the ./docs-before directory)
5. Open a change request and make a simple modification
6. Publish and view the docs
7. Customize the docs - change the styling, the fonts, the icons - then republish
8. Add your OpenAPI spec - use the "before" spec
9. Add an OpenAPI block to your page
10. Add a set of OpenAPI pages to your docs and re-publish your docs
11. Customize your OpenAPI spec, push changes, refresh the spec, and see the changes
12. Ask some questions about the spec to the GitBook Assistant

Examples:

• The starting docs site
• The finished docs site