文档目录

欢迎阅读 APIFlask 的文档。

目录

你可以通过阅读以下章节来了解 APIFlask 的用法：

• 引言：一个关于 APIFlask 的总体介绍。
• 从 Flask 迁移：迁移指南与注意事项。
• 基本用法：开始使用 APIFlask。
• 请求处理：对 @app.input 装饰器的详细介绍。
• 响应格式化： 对 @app.output 装饰器的详细介绍。
• 数据 Schema：如何编写输入数据与输出数据的 schema。
• OpenAPI 支持：生成 OpenAPI spec 的原理，以及如何通过 @app.doc 装饰器和配置变量来进行自定义。
• 安全认证：给你的应用实现认证支持。
• Swagger UI 和 Redoc：API 文档工具的用法和配置
• 配置：内置的配置变量表。
• 应用示例：应用示例集。

以下章节对贡献者和想要继续了解 APIFlask 的人有用。

• API 参考：APIFlask 的 API 参考。
• 比较与动机：APIFlask 和类似项目的区别。
• 作者：APIFlask 的作者。
• 变更日志：APIFlask 各个版本的变更日志。

外部文档

在 APIFlask 文档中，我将尝试覆盖所有的基本用法。然而，如果要使用一些高级用法，你可能需要 阅读一些 APIFlask 依赖的框架、工具的文档：

• Flask：你有必要掌握 Flask 的知识。
• marshmallow：Schema 的高级用法参考。
• Flask-HTTPAuth：HTTPBasicAuth 和 HTTPTokenAuth 的高级用法参考。
• webargs：如果你是贡献者，这将会有用。
• apispec：如果你是贡献者，这将会有用。
• OpenAPI：这是 OpenAPI 的规范。
• JSON Schema：当你想要设定一个个性化的错误响应 schema 而且不想用 schema 类时，这将很有用。