New: AI Insights are here.
See what your users are asking.
LogoLogo
CtrlK
ProductPricingLog inSign up
🇺🇸 English
  • Documentation
  • Guides
  • Developers
  • Changelog
  • Get Started
    • Overview
    • Quickstart
    • AI-native documentation
    • Migrate to GitBook
    • GitHub & GitLab Sync
      • Enabling GitHub Sync
      • Enabling GitLab Sync
      • Content configuration
      • GitHub pull request preview
      • Commit messages & Autolink
      • Monorepos
      • Troubleshooting
      • Skill.md
  • Your docs site
    • Site settings
    • Site customization
      • Icons, colors, and themes
      • Layout and structure
      • Sharing and social
      • Extra configuration
    • Site structure
      • Site sections
      • Content variants
      • Multilingual sections
    • AI Search
    • 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
    • Publish a docs site
      • Public publishing
      • Private publishing with share links
      • Authenticated access
    • Site redirects
    • Embed in your product
      • Implementation
        • Script tag
        • Node.js/NPM
        • React
      • Authentication
      • Configuration
        • Customizing the Embed
        • Connect to custom tools
        • API Reference
    • AI insights
    • Site analytics
    • PDF export
  • Create content
    • Formatting your content
      • Inline content
      • Markdown
    • Content structure
      • Spaces
      • Pages
        • Tags
      • 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
      • Custom blocks
    • AI coding assistants and skill.md
    • Variables and expressions
    • Reusable content
    • Searching internal content
      • Search & Quick find
      • GitBook AI
    • Version control
  • Collaborate
    • Inviting your team
    • Member management
      • Manage or remove members
      • Permissions and inheritance
      • Roles
      • Teams
    • Change requests
      • Change requests screen
      • Change requests in a space
    • Merge rules
    • Comments
    • Notifications
    • Live edits
  • Site access
    • 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
    • Connections
    • LLM-ready docs
    • MCP servers for published docs
  • GitBook Agent
    • What is GitBook Agent?
    • Channels
    • Writing with GitBook Agent
    • Review change requests with GitBook Agent
    • Translations
  • 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
      • Using OpenAPI proxy
      • Describing enums
      • Integrating with CI/CD
    • Extensions reference
  • Integrations
    • Install and manage integrations
  • Account management
    • Plans
      • Community plan
        • Sponsored site plan
      • Billing policy
    • Subscription cancellations
    • Personal settings
    • Organization settings
    • SSO & SAML
      • SSO Members vs non-SSO
  • Resources
    • GitBook UI
      • Toolbar on published sites and site previews
    • Keyboard shortcuts
    • Glossary
    • Concepts
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Document an API

Guides

Structuring 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