# tpShop **Repository Path**: smallcatx0/tpShop ## Basic Information - **Project Name**: tpShop - **Description**: 基于AOP思想 thinkphp5 编写的 RESTFull API(商城后端) - **Primary Language**: PHP - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2019-03-07 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # RESTFul API 个人理解 ### 1.HTTP 动词的语义化 - POST 创建资源 - PUT 更新资源 - GET 查询资源 - DELETE 删除资源 ### 2.HTTP请求状态码 - 404 资源未找到 - 400 参数校验失败 - 401 未授权 - 403 资源禁止访问 - 200 一个GET(查询)操作,请求成功 - 201 一个POST(创建资源)操作成功 - 202 一个PUT(更新资源)操作成功 - 500 服务器未知错误 ### 3.自定义错误码 统一描述错误,每个项目都应该有一套完善的错误码,以及对应的文档。 - 为什么要定义错误码而不是成功码/状态码? 正确的结果就一种状态,而错误的情况千奇百怪。即`0`表示没有错误。所有的非零则表示各种各样的错误。 ### 基于以上的规范 我们的每个接口都应的规范为: ```json { "errorCode" : "****", "msg": "****************", "data":{...} } ``` ### 4.使用TOKEN令牌来授权和身份认证 token直接放到http的请求头上而不是当成普通参数进行传递 ### 5.URL语义明确 开启严格路由模式