接口编写 文档规范 总结

正文：

一：协议规范

为进一步确保数据交互安全。正式地址（生产地址）必须遵循HTTPS协议。

二：域名规范

每个项目要有且仅有一个自己唯一的域名+端口。在项目配置文件中要添加静态变量专门进行存储。

如果一个域名满足不了要求，那么就需要再添加一个。

格式规范如下：

（java）public static final String URL_BASE = “https://127.0.0.1:8080/”;

（java）public static final String URL_BASE_SUB = “https://192.168.0.1:8080/”;

必须以https开头，并以“/”结尾。

三：API路径规范

作为接口路径，为了和其他路径完美区分，必须在路径中添加api目录

格式规范如下：

（java）public static final String URL_API = “api/”;

（PHP）php目录是加index.php/api/

必须以字母开头，并以“/”结尾。

四：版本控制规范

项目正式上线后，正式版本要确定接口版本、并备份接口代码。

为方便管理，需要在接口路径中加入版本号信息。

格式规范如下：

（java）public static fina