GitBook Agent is here! Introducing a new way to ideate, plan, and ship docs.
Find out more
LogoLogo
Ctrlk
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
GitBook Assistant
GitBook Assistant
Working...Thinking...
GitBook Assistant
Good night

I'm here to help you with the docs.

Ctrli
AI Based on your context
  • Get Started
    • GitBook documentation
    • Quickstart
    • Concepts
    • Migrate to GitBook
    • AI-native documentation
    • GitHub & GitLab Sync
  • Create
    • Formatting your content
    • Content structure
    • Blocks
    • Variables and expressions
    • Reusable content
    • Searching internal content
    • Version control
  • GitBook Agent
    • What is GitBook Agent?
    • Automatic documentation suggestions
    • Writing with GitBook Agent
    • Review change requests with GitBook Agent
    • Translations
  • Collaborate
    • Inviting your team
    • Change requests
    • Merge rules
    • Comments
    • Notifications
    • PDF export
    • Live edits
  • Document an API
    • OpenAPI
    • Guides
      • Structuring your API reference
      • Adding custom code samples
      • Managing API operations
      • Configuring the “Test it” button
      • Describing enums
      • Integrating with CI/CD
    • Extensions reference
  • Publish Documentation
    • Publish a docs site
    • Site structure
    • Site customization
    • Set a custom domain
    • Setting a custom subdirectory
    • Site settings
    • Site insights
    • Site redirects
    • Authenticated access
    • Adaptive content
    • AI Search
    • GitBook Assistant
    • LLM-ready docs
    • MCP servers for published docs
    • Embed in your product
  • Integrations
    • Install and manage integrations
  • Account management
    • Plans
    • Subscription cancellations
    • Personal settings
    • Organization settings
    • Member management
    • SSO & SAML
  • Resources
    • GitBook UI
    • Keyboard shortcuts
    • Glossary
Powered by GitBook
On this page
  1. Document an API

Guides

Structuring your API referenceAdding custom code samplesManaging API operationsConfiguring the “Test it” buttonDescribing enumsIntegrating with CI/CD

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service

Was this helpful?