- 博客(2)
- 收藏
- 关注
RSS订阅转载 API设计指南-RestAPI设计最佳实践
类似于阿里巴巴的开发规范或者谷歌的开发规范，API设计是目前很多场景下的基本功，所以这里给出一个笔者的最佳实践。一、引言REST，即Representational State Transfer的缩写，关于RESTful架构，可以参考《架构之美》中的定义。客户端和服务器之间的交互在请求之间是无状态的，每个请求都必须包含理解请求的全部信息。 在此基础上，服务更容易实现分布式、水平扩展、异步处理和可重入（幂等请求）。REST架构中的基本定义资源(Resource): 网络上的所有内容都表
2020-08-19 21:33:22
803
转载 一个接口文档模板的API设计流程
1. 基础说明1.1 背景[说明文档用途]编写本文的目的是为了将系统功能进行模块化、服务化，将用户的操作以服务的方式提供。系统与系统之间遵循服务规范，将系统与系统之间的交互转为定制化服务交互，以实现系统与系统之间的集成。1.2 基本约束1.2.1 基本设计原则1.2.2 字符集所有接口字符集采用UTF-8。1.2.3 返回类型约束所有接口返回必须是严格定义的JSON类型。1.2.4 接口版本约束不允许发布无版本号的接口。 接口版本首先解决的是一组接口的版本问题。1
2020-08-19 21:30:40
1301
空空如也
空空如也
TA创建的收藏夹 TA关注的收藏夹
TA关注的人