How-to Guides

These guides show you how to accomplish specific tasks with Flask-Jeroboam. Each guide addresses a real-world need and provides practical examples you can apply to your own code.

Contents:

• How to validate request data
  • Simple scalar parameters
  • Query vs body parameters
  • Using Pydantic models
  • Field constraints
  • Path parameters
  • Headers and cookies
  • Conditional validation
  • Optional fields
• How to serialize responses
  • Simple response models
  • Lists and collections
  • Field aliases
  • Excluding fields
  • Nested responses
  • Optional responses
  • Type coercion
  • Computed fields
  • Custom serializers
• How to customize API documentation
  • Adding descriptions
  • Documenting parameters
  • Response descriptions
  • Customizing endpoints
  • Grouping endpoints with tags
  • Hiding endpoints from docs
  • Documenting errors
  • Authentication in docs
  • Examples in docs
  • Deprecating endpoints
• How to configure Flask-Jeroboam
  • Disabling OpenAPI docs
  • Customizing the docs URL
  • Changing the OpenAPI title
  • Disabling automatic error handlers
  • Response validation
  • Using with application factory pattern
  • Configuration with environment variables
  • Custom error responses
  • Response headers
  • Caching responses
  • CORS configuration
  • Logging and debugging
  • Performance tuning