企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
## 编码风格 > 代码必须遵守PSR-2代码风格。 ### 基本命名规则概要 **类名**必须为大写驼峰 **类属性**必须为小写驼峰 **方法名**必须为小写驼峰 **函数名**必须为小写+下划线 **常量名**必须为大写+下划线 ### 团队内规范 * PSR-2未提到的变量命名规则统一以小写下划线的形式命名。例如:方法内变量命名,函数内变量命名,方法与函数的参数变量命名。 * 命名必须以常用英文单词、单词简写或约定俗成的拼音进行命名,禁止英文单词与拼音混合的方式命名。 ### IDE代码规范检查插件 phpstorm在plugins中搜索 `php inspections` 安装,文件或文件夹右键 `inspect code` 即可检查 ## RESTful API规范(接口) 项目接口应该在开发之前就列出来,然后按照接口列表创建接口文档,前端与后端可并行开发。 返回状态码: 200 400 500 ``` 返回状态码 状态码相关的思考,目前考虑到两种自认为你相对符合目前情况的。 1、200,400,401,403,404,500。比正常的状态码简单,不过针对目前情况稍显繁琐。 2、200,400,500,感觉有点太简陋了。 最终挣扎,401客户端需要重新授登录,必须。400为所有客户端错误,具体错误以message的形式描述在body内,500为服务端的错误,具体消息同上。200成功不做讨论。 以上想法需要和其他成员沟通。 ``` ## 参考资料 [PSR中文翻译](https://learnku.com/docs/psr) [PSR-2编码风格规范](https://www.php-fig.org/psr/psr-2/) [PSR-2编码风格规范中文翻译](https://learnku.com/docs/psr/psr-2-coding-style-guide/1606) [RESTful API 设计指南](http://www.ruanyifeng.com/blog/2014/05/restful_api.html) [理解RESTful架构](http://www.ruanyifeng.com/blog/2011/09/restful.html)