Skip to content

FastAPI Foundation 入门主页

这是新手的第一入口:从“最短可运行路径”开始,后续再深入到模块开发和运维。

5 分钟上手图(建议顺序)

  1. 启动前环境确认(core --help
  2. 生成配置并校验 core config template --profile local --json
  3. 校验配置 core check-config --profile local --json
  4. 生成演示 APP core bootstrap-app books --target-root src --package platform_apps --json
  5. 检查模块 core check-app platform_apps.books.module --json
  6. 预检启动 core serve --dry-run --json
  7. 正式启动 core serve --run --host 127.0.0.1 --port 8000 --json
  8. core 命令和 API 做一次登录 + 业务接口验证

你最先看的文档(按“先跑起来”优先)

系统默认入口(本地启动后快速验证)

  • GET /healthz:服务可达性
  • GET /readyz:依赖与初始化状态
  • GET /version:版本与启动元信息
  • GET /docs:OpenAPI
  • GET /metrics:Prometheus 指标

关键业务端点(示例)

  • POST /api/v1/auth/login
  • POST /api/v1/auth/refresh
  • POST /api/v1/auth/logout
  • GET /api/v1/me
  • POST /api/v1/platform/tenants
  • GET /api/v1/platform/tenants/{tenant_id}/members

你可以直接照着这 4 条线走完一个完整闭环

  1. 应用开发线quickstartnew-developer-workbookapp-development
  2. 安全线authenticationauthorization-and-roles
  3. 数据线data-relationshipsapi/tenant-isolation
  4. 发布线cli-guidequickstart-checklisttroubleshooting