Docs Agents are here! Introducing a new way to ideate, plan, and ship docs.
Find out more
LogoLogo
CtrlK
ProductPricingLog inSign up
🇺🇸 English
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Get Started
    • GitBook documentation
    • Quickstart
    • Concepts
    • Migrate to GitBook
    • AI-native documentation
    • GitHub & GitLab Sync
      • Enabling GitHub Sync
      • Enabling GitLab Sync
      • Content configuration
      • GitHub pull request preview
      • Commit messages & Autolink
      • Monorepos
      • Troubleshooting
  • Create
    • Formatting your content
      • Inline content
      • Markdown
    • Content structure
      • Spaces
      • Pages
      • Collections
    • Blocks
      • Paragraphs
      • Headings
      • Unordered lists
      • Ordered lists
      • Task lists
      • Hints
      • Quotes
      • Code blocks
      • Files
      • Images
      • Embedded URLs
      • Tables
      • Cards
      • Tabs
      • Expandable
      • Stepper
      • Updates
      • Drawings
      • Math & TeX
      • Page links
      • Columns
      • Conditional content
      • Buttons
      • Icons
      • Expressions
    • Variables and expressions
    • Reusable content
    • Searching internal content
      • Search & Quick find
      • GitBook AI
    • Version control
  • GitBook Agent
    • What is GitBook Agent?
    • Automatic documentation suggestions
      • Connecting a source
      • Exploring your data
    • Writing with GitBook Agent
    • Review change requests with GitBook Agent
    • Translations
  • Collaborate
    • Inviting your team
    • Change requests
      • Change requests screen
      • Change requests in a space
    • Merge rules
    • Comments
    • Notifications
    • PDF export
    • Live edits
  • Document an API
    • OpenAPI
      • Add an OpenAPI specification
      • Insert API reference in your docs
    • 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
      • Public publishing
      • Private publishing with share links
    • Site structure
      • Site sections
      • Content variants
    • Site customization
      • Icons, colors, and themes
      • Layout and structure
      • Extra configuration
    • Set a custom domain
    • Setting a custom subdirectory
      • Configuring a subdirectory with Cloudflare
      • Configuring a subdirectory with Vercel
      • Configuring a subdirectory with AWS using CloudFront and Route 53
    • Site settings
    • Site insights
    • Site redirects
    • Authenticated access
      • Enabling authenticated access
      • Setting up Auth0
      • Setting up Azure AD
      • Setting up AWS Cognito
      • Setting up Okta
      • Setting up OIDC
      • Setting up a custom backend
    • Adaptive content
      • Enabling adaptive content
        • Cookies
        • URL
        • Feature flags
        • Authenticated access
      • Adapting your content
      • Testing with segments
    • AI Search
    • GitBook Assistant
    • LLM-ready docs
    • MCP servers for published docs
    • Embed in your product
      • Implementation
        • Script tag
        • Node.js/NPM
        • React
      • Authentication
      • Configuration
        • Customizing the Embed
        • Creating custom tools
        • API Reference
  • Integrations
    • Install and manage integrations
  • Account management
    • Plans
      • Community plan
        • Sponsored site plan
      • Billing policy
    • Subscription cancellations
    • Personal settings
    • Organization settings
    • Member management
      • Invite or remove members
      • Roles
      • Teams
      • Permissions and inheritance
    • SSO & SAML
      • SSO Members vs non-SSO
  • Resources
    • GitBook UI
      • Toolbar on published sites and site previews
    • Keyboard shortcuts
    • Glossary
Powered by GitBook
On this page

Was this helpful?

  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