FastAPI Foundation 入门主页
这是新手的第一入口:从“最短可运行路径”开始,后续再深入到模块开发和运维。
5 分钟上手图(建议顺序)
- 启动前环境确认(
core --help) - 生成配置并校验
core config template --profile local --json - 校验配置
core check-config --profile local --json - 生成演示 APP
core bootstrap-app books --target-root src --package platform_apps --json - 检查模块
core check-app platform_apps.books.module --json - 预检启动
core serve --dry-run --json - 正式启动
core serve --run --host 127.0.0.1 --port 8000 --json - 用
core命令和 API 做一次登录 + 业务接口验证
你最先看的文档(按“先跑起来”优先)
系统默认入口(本地启动后快速验证)
GET /healthz:服务可达性GET /readyz:依赖与初始化状态GET /version:版本与启动元信息GET /docs:OpenAPIGET /metrics:Prometheus 指标
关键业务端点(示例)
POST /api/v1/auth/loginPOST /api/v1/auth/refreshPOST /api/v1/auth/logoutGET /api/v1/mePOST /api/v1/platform/tenantsGET /api/v1/platform/tenants/{tenant_id}/members
你可以直接照着这 4 条线走完一个完整闭环
- 应用开发线:
quickstart→new-developer-workbook→app-development - 安全线:
authentication→authorization-and-roles - 数据线:
data-relationships→api/tenant-isolation - 发布线:
cli-guide→quickstart-checklist→troubleshooting