Skip to main content

OpenAPI

BrowserBee publishes an OpenAPI specification and an interactive reference experience. Together they give you both human-readable endpoint exploration and machine-readable API contracts.

Interactive reference​

What OpenAPI is useful for​

OpenAPI is especially valuable when you want to:

  • generate clients in your preferred language
  • validate requests and responses in tests
  • review request and response schemas before coding
  • wire BrowserBee into platform or gateway tooling
  • keep multiple services aligned to the same contract

Why it matters​

OpenAPI enables:

  • generated clients/SDKs
  • request/response validation
  • contract-driven testing
  • integration into API gateways and tooling
  1. Explore the endpoint manually in API Reference.
  2. Confirm the exact path, method, and parameter contract.
  3. Generate or update a client if your codebase uses one.
  4. Wrap the generated client with BrowserBee-specific auth and retry behavior.
  5. Keep the generated layer thin and push business logic into your application.

Good defaults for teams​

  • keep the generated client isolated from business logic
  • regenerate clients intentionally rather than ad hoc
  • validate breaking changes in CI before updating shared integrations
  • document which generated version each service is using