How to design URI in open interface system
Overview
考虑到当前互联网系统主要面向个人端手机app、企业、运营平台,故而,可以将整个系统的URI部分做一个统一规划。
/api/${domain}/[${system_code}/][${module_code}/]${service_name}/
其中,${domain}
可以取值为c
、b
、p
,分别代表手机APP(mobile app)、企业(enterprise)、运营(operation),这样以来,上面的规则进而可以展开为:
- Service interface for mobile app
/api/c/[${system_code}/][${module_code}/]${service_name}/
- Service interface for enterprise
/api/b/[${system_code}/][${module_code}/]${service_name}/
- Service interface for operation
/api/p/[${system_code}/][${module_code}/]${service_name}/
其中,system_code
代表子系统,module_code
代表模块,service_name
代表服务。system_code
、module_code
可选,具体根据实际需要而定。