New: AI Insights are here.
See what your users are asking.
LogoLogo
⌘Ctrlk
ProductPricingLog inSign up
  • Documentation
  • Guides
  • Developers
  • Changelog
GitBook Assistant
GitBook Assistant
GitBook Assistant
Good night

I'm here to help you with the docs.

⌘Ctrli
AI Based on your context
LogoLogo
  • Overview
    • Quickstart
    • Build with AI
    • Migrate to GitBook
    • GitHub & GitLab Sync
    • Site settings
    • Site customization
    • Site structure
    • AI Search
    • Set a custom domain
    • Publish a docs site
    • Site redirects
    • Embed in your product
    • AI insights
    • Site analytics
    • PDF export
    • Formatting your content
    • Content structure
    • Blocks
    • Variables and expressions
    • Reusable content
    • Styleguide
    • Searching internal content
    • Version control
    • Inviting your team
    • Member management
    • Change requests
    • Merge rules
    • Comments
    • Notifications
    • Live edits
    • Authenticated access
    • Adaptive content
    • GitBook Assistant
    • Connections
    • LLM-ready docs
    • MCP servers for published docs
    • What is GitBook Agent?
    • Channels
    • Identify content gaps
    • Writing with GitBook Agent
    • Review change requests with GitBook Agent
    • Translations
    • OpenAPI
    • Guides
      • OpenAPI layouts
      • Structuring your API reference
      • Adding custom code samples
      • Managing API operations
      • Configuring the “Test it” button
      • Using OpenAPI proxy
      • Describing enums
      • Integrating with CI/CD
    • Extensions reference
    • Install and manage integrations
    • Plans
    • Subscription cancellations
    • Personal settings
    • Organization settings
    • SSO & SAML
    • GitBook UI
    • Keyboard shortcuts
    • Glossary
    • Concepts
Powered by GitBook
For the complete documentation index, see llms.txt. This page is also available as Markdown.
  1. Documentation
  2. Document an API

Guides

OpenAPI layoutsStructuring your API referenceAdding custom code samplesManaging API operationsConfiguring the “Test it” buttonUsing OpenAPI proxyDescribing enumsIntegrating with CI/CD

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
x-twitterlinkedinyoutube

Was this helpful?