API 接口设计规范实践

链接 / 1 / 3 / 创建于 6年前

分享链接：https://shuwoom.com/?p=2463
通过对过往项目的总结，总结出 API 接口设计上的一些规范，具体开发跟 php 框架无关，主要还是 API 的设计规范，可以让代码结构更加清晰。

79 声望

暂无个人描述~

《L02 从零构建论坛系统》

以构建论坛项目 LaraBBS 为线索，展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。

《G01 Go 实战入门》

从零开始带你一步步开发一个 Go 博客项目，让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。

推荐文章：

更多推荐...

冯老师的困惑 —— 我没有说话 10 / 12 |

Vim 实用小技巧系列——操作符 + 动作命令，让「操作」秀起来 15 / 5 |

Vim 实用小技巧系列——如何在文本的行首行尾批量添加内容？ 12 / 17 |

Redis 实用小技巧——浅谈 Redis 使用规范 11 / 8 |

Redis 实用小技巧—— bitmap 应用之「签到统计」 18 / 14 |

接口的幂等性解决方案 10 / 0 |

讨论数量: 3

Wi1dcard

管理员 2.1k 声望

个人建议（只是建议）：

Language 字段完全可以由 Accept-Language 请求头代替，没有必要自己定义一套标准。
Request-ID 应当统一由服务端生成唯一 ID 并在响应头内返回给客户端，客户端生成容易冲突也容易造成漏洞。
字段名，少见采用 StudlyCaps 的，采用主流的 camelCase 和 snake_case 或许更合适：https://stackoverflow.com/a/25368854/10895...
类命名不遵循 PSR 真的好吗...
一条不相关的：emmmm，其实有点让我想起三年前的自己 😂😂😂

6年前评论

shuwoom

79 声望

@Wi1dcard 非常感谢指点哈后续我继续完善:smile:

6年前评论

lovecn

188 声望

@Wi1dcard 大佬看得仔细

6年前评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助