Skip to content

Documentation Index

Welcome to APIFlask's documentation!

Documentation progress:

Contents

Go through the following chapters to learn how to use APIFlask:

  • Introduction: A general introduction for APIFlask.
  • Migrating from Flask: Migrating guide and notes.
  • Basic Usage: Get started with APIFlask.
  • Schema, Fields, and Validators: Introduce how to write an input/output schema.
  • Request Validating: The detailed introduction of the @input decorator.
  • Response Formatting: The detailed introduction of the @output decorator.
  • OpenAPI Generating: Introduce how the OpenAPI generation works and how to customize it with @doc decorator and configuration variables.
  • Authentication: Introduce how to implement HTTP Basic and Token-based authentication.
  • Swagger UI and Redoc: Introduce the usage and configuration of the API documentation tools.
  • Configuration: A list of all the built-in configuration variables
  • Examples: A collection of application examples.

The following chapters are useful for contributors and who want to know more about APIFlask:

External Documentations

I will try to cover all the basic usages in APIFlask's documentation. However, for advanced usages, you may need to read the documentation of the framework, tools that APIFlask based on:

  • Flask: The knowledge of Flask is required.
  • Marshmallow: Advanced reference for schema.
  • Flask-HTTPAuth: Advanced reference for the usage of HTTPBasicAuth and HTTPTokenAuth.
  • Webargs: Useful for contributors.
  • APISpec: Useful for contributors.
  • OpenAPI: The OpenAPI Specification.
  • JSON Schema: Useful when you want to set a custom error schema and you don't want to use schema class.