Bump.sh
Documentation Product updates Guides OpenAPI specification Arazzo specification
API reference Bump.sh

OpenAPI Specification
  • 3.1
  • 3.2

  • Home
  • Introduction to OpenAPI
    • What is OpenAPI?
    • History and Evolution of OpenAPI
    • Benefits of Using OpenAPI
  • Understanding OpenAPI Structure
    • Basic Structure
    • Defining API Servers
    • Paths and Operations
    • Parameters (Path, Query, Header, and Cookie)
    • Parameter Serialization
    • HTTP Requests
    • HTTP Responses
    • Components Section
  • Defining Data Models
    • Schema and Data Types
    • JSON Schema in OpenAPI
    • Examples and Default Values
    • Schema Composition
    • Representing XML
  • Advanced OpenAPI Specification
    • Splitting OpenAPI into Multiple Documents
    • Multipart Form Data
    • Pagination
    • File Uploads
    • Supporting Multiple Content Types
    • Handling Error Formats
    • Security (Authentication and Authorization)
    • Callbacks and Webhooks
    • JSON Streaming
  • Documenting APIs
    • Adding Descriptions and Summaries
    • Grouping Operations with Tags
    • Linking to External Documentation
  • Extending OpenAPI
    • Custom Extensions and Vendor Extensions
    • Enriching OpenAPI with Overlays
  • The Perfect Modern OpenAPI Workflow
  • The Cheat Sheet

Bump.sh, the API doc platform for Tech Writers & Engineers

Get started for free