# 📚 TYAPI Server 文档中心 欢迎使用 TYAPI Server 文档中心！我们已将原本的使用指南拆分为多个专题文档，方便您按需查阅。 ## 📋 文档导航 ### 🚀 [快速开始指南](./快速开始指南.md) - 前置要求 - 一键启动 - 验证安装 - 访问管理界面 ### 🔧 [环境搭建指南](./环境搭建指南.md) - 开发环境配置 - 生产环境配置 - 服务配置说明 - 常见配置问题 ### 📋 [Makefile 命令指南](./MAKEFILE_GUIDE.md) - 所有 Make 命令详细说明 - 常用工作流程 - 构建和部署命令 - 开发工具命令 - 故障排除技巧 ### 👨‍💻 [开发指南](./开发指南.md) - 项目结构理解 - 开发流程 - 测试编写 - 调试技巧 - 代码规范 ### 🌐 [API 使用指南](./API使用指南.md) - 认证机制 - 用户管理 API - 响应格式 - HTTP 状态码 - API 测试 ### 🚀 [部署指南](./部署指南.md) - Docker 部署 - Kubernetes 部署 - 云平台部署 - 负载均衡配置 - 监控部署 ### 📦 [生产环境部署指南](./生产环境部署指南.md) - Docker + 私有 Registry 完整部署方案 - 多阶段构建生产级镜像 - 安全配置和资源限制 - 自动化部署脚本 - 监控和故障排除 ### 🔍 [故障排除指南](./故障排除指南.md) - 常见问题 - 日志分析 - 性能问题 - 紧急响应流程 ### 📋 [最佳实践指南](./最佳实践指南.md) - 开发最佳实践 - 安全最佳实践 - 性能最佳实践 - 运维最佳实践 - 团队协作 ### 🔍 [链路追踪指南](./链路追踪指南.md) - Jaeger 配置和使用 - OpenTelemetry 集成 - Grafana 可视化 - 性能监控和优化 - 故障排查技巧 ## 🎯 快速索引 ### 新手入门 1. [快速开始指南](./快速开始指南.md) - 5 分钟快速体验 2. [环境搭建指南](./环境搭建指南.md) - 配置开发环境 3. [Makefile 命令指南](./MAKEFILE_GUIDE.md) - 掌握所有开发命令 4. [开发指南](./开发指南.md) - 开始第一个功能 ### 日常开发 - [Makefile 命令指南](./MAKEFILE_GUIDE.md) - 构建、测试、部署命令 - [API 使用指南](./API使用指南.md) - API 调用参考 - [开发指南](./开发指南.md) - 开发流程和规范 - [链路追踪指南](./链路追踪指南.md) - 性能监控和问题排查 - [故障排除指南](./故障排除指南.md) - 解决常见问题 ### 生产部署 - [部署指南](./部署指南.md) - 生产环境部署 - [生产环境部署指南](./生产环境部署指南.md) - Docker + 私有 Registry 完整方案 - [最佳实践指南](./最佳实践指南.md) - 运维最佳实践 - [故障排除指南](./故障排除指南.md) - 生产问题排查 ## 🔗 相关文档 ### 技术文档 - [架构文档](./ARCHITECTURE.md) - 系统架构设计 - [API 规范](http://localhost:8080/swagger/) - 在线 API 文档 ### 项目文档 - [README](../README.md) - 项目介绍 - [更新日志](../CHANGELOG.md) - 版本变更记录 ## 📞 获取帮助 ### 在线资源 - **Swagger UI**: http://localhost:8080/swagger/ - **健康检查**: http://localhost:8080/api/v1/health - **监控面板**: http://localhost:3000 (Grafana) - **链路追踪**: http://localhost:16686 (Jaeger) ### 社区支持 - **GitHub Issues**: 提交问题和建议 - **Wiki**: 查看详细技术文档 - **讨论区**: 参与技术讨论 ## 🔄 文档更新 本文档会持续更新，如果您发现任何问题或有改进建议，请： 1. 提交 GitHub Issue 2. 发起 Pull Request 3. 联系维护团队 --- **提示**：建议将此页面加入书签，方便随时查阅相关文档。