Norish开发入门：从API接口到插件开发的完整技术文档

Norish开发入门从API接口到插件开发的完整技术文档【免费下载链接】norishNorish - A realtime, self-hosted recipe app for families friends项目地址: https://gitcode.com/gh_mirrors/no/norishNorish是一款实时的、自托管的家庭和朋友食谱应用本指南将帮助开发者从API接口使用到插件开发快速掌握Norish的技术架构和扩展方式。通过本文你将了解如何搭建开发环境、利用API接口进行数据交互以及开发自定义插件来扩展Norish的功能。开发环境搭建环境要求Node.js22.22.0见.nvmrcpnpm10.x或更高版本Docker用于PostgreSQL、Redis和无头ChromeGit本地开发设置# 克隆仓库 git clone https://gitcode.com/gh_mirrors/no/norish cd norish # 安装依赖 pnpm install # 创建环境文件 cp .env.example .env.local # 启动所需服务Postgres、Redis、Chrome pnpm run docker:up # 运行Web应用 pnpm run dev # 运行移动应用Expo pnpm run dev:mobile至少需要在.env.local中配置DATABASE_URL、REDIS_URL、AUTH_URL和MASTER_KEY使用openssl rand -base64 32生成。详细配置可参考Server runtime和Database。API接口详解Norish在/api/v1路径下提供HTTP API接口方便开发者进行数据交互和扩展。认证方式通过以下任一方式传递API密钥x-api-key: your-api-keyAuthorization: Bearer your-api-key注意/api/docs和/api/openapi.json需要已登录的Web会话GET /api/v1/health是公开的健康检查接口其他所有/api/v1端点都需要API凭证。主要端点健康检查GET /api/v1/health- 公共健康检查接口返回API和内部解析器服务的健康状态。食谱管理GET /api/v1/recipes/{id}- 获取指定ID的食谱详情POST /api/v1/recipes/search- 列出食谱支持可选过滤条件POST /api/v1/recipes/import/url- 从URL导入食谱POST /api/v1/recipes/import/paste- 粘贴导入食谱POST /api/v1/recipes/search返回分页的食谱列表可选过滤条件包括search、searchFields、tags、categories、filterMode、sortMode、minRating和maxCookingTime。cursor默认为0limit默认为50。食材管理GET /api/v1/groceries- 获取食材列表POST /api/v1/groceries- 添加新食材PATCH /api/v1/groceries/{id}/done- 标记食材为已购买PATCH /api/v1/groceries/{id}/undone- 标记食材为未购买PATCH /api/v1/groceries/{id}/store- 更新食材的存储位置DELETE /api/v1/groceries/{id}- 删除食材针对单个食材的修改端点需要version字段以实现乐观并发控制。PATCH /api/v1/groceries/{id}/store在请求体中接受storeId和可选的savePreference。商店管理GET /api/v1/stores- 获取商店列表POST /api/v1/stores- 添加新商店计划食谱GET /api/v1/planned-recipes/today- 获取今日计划食谱GET /api/v1/planned-recipes/week- 获取本周计划食谱GET /api/v1/planned-recipes/month- 获取本月计划食谱POST /api/v1/planned-recipes- 添加计划食谱DELETE /api/v1/planned-recipes/{itemId}- 删除计划食谱计划食谱范围端点使用服务器时区来确定今天/周/月的边界周范围是从周一到周日。插件开发指南虽然Norish目前没有专门的插件系统但可以通过以下方式扩展功能共享模块开发Norish采用模块化架构通过创建共享模块可以实现功能扩展。主要共享模块位于packages/shared-react/src/hooks/和packages/shared-react/src/contexts/目录下。例如创建一个新的共享钩子模块在packages/shared-react/src/hooks/目录下创建新的钩子文件实现钩子逻辑确保不导入特定平台的模块在packages/shared-react/src/index.ts中导出新钩子集成第三方服务可以通过API接口集成第三方服务例如集成AI食材识别服务添加新的食谱导入来源连接外部日历服务集成方式通常是创建新的API端点或使用现有端点的扩展参数具体实现可参考packages/api/src/parser/目录下的解析器模块。自定义主题和样式Norish使用Tailwind CSS进行样式管理可以通过以下方式自定义主题修改tooling/tailwind/heroui-theme.css文件扩展tooling/tailwind/heroui-theme.js中的主题配置在应用中使用自定义CSS类高级开发技巧测试策略Norish使用Vitest进行测试测试文件通常与被测试模块放在同一目录下命名为*.test.ts或*.test.tsx。可以使用以下命令运行测试pnpm run test代码质量工具项目使用ESLint和Prettier进行代码质量控制相关配置位于tooling/eslint/和tooling/prettier/目录下。提交代码前建议运行pnpm run lint pnpm run format性能优化使用React.memo和useMemo优化组件渲染合理使用TanStack Query进行数据缓存优化图片加载使用适当的尺寸和格式总结Norish提供了强大的API接口和模块化架构使开发者能够轻松扩展其功能。通过本文介绍的开发环境搭建、API接口使用和插件开发方法你可以开始构建自定义功能和集成第三方服务。如需更多帮助请参考项目中的开发命令文档和贡献指南。祝你的Norish开发之旅顺利 【免费下载链接】norishNorish - A realtime, self-hosted recipe app for families friends项目地址: https://gitcode.com/gh_mirrors/no/norish创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考