前后端规约
文章目录
- 引言
- I 【强制】
-
- 前后端交互的 API
- 请求内容
- 响应体
- 响应码
- II 【推荐】
-
- MVC
- 响应体
- III【参考】
- IV 其他
引言
- 服务器内部重定向必须使用 forward；
- 外部重定向地址必须使用 URL 统一代理模块生成，否则会因线上采用 HTTPS 协议而导致浏览器提示“不安全”，并且还会带来 URL 维护不一致的问题。
I 【强制】
前后端交互的 API
需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体。
- 1）协议：生产环境必须使用 HTTPS。
- 2）路径：每一个 API 需对应一个路径，表示 API 具体的请求地址：
a）代表一种资源，只能为名词，推荐使用复数，不能为动词，请求方法已经表达动作意义。
b）URL 路径不能使用大写，单词如果需要分隔，统一使用下划