一文详解 API 设计最佳实践
Java资料站
共 3481字,需浏览 7分钟
· 2021-09-06
点击上方蓝色字体,选择“标星公众号”
优质文章,第一时间送达
- 前言 -
- 为什么要使用 API? -
API 可以让外部应用访问您的资源 API 扩展了应用程序的功能 API 允许开发者重用应用逻辑 API 是独立于平台的,它们传递数据不受请求平台的影响
![](https://filescdn.proginn.com/155b8505766c3a1034ab054b91d67dcf/45b1109f09adc81124e2ac72ff37d3e4.webp)
- 数据建模与结构化 -
https://api.domain.com/authors
https://api.domain.com/authors/{id}/books
- 编写面向资源的 API -
Base Path -> 作者 (集合) -> profile (资源)
书 (资源)
命名集合和资源时使用美式英语(例如:color 而不是 colour) 避免拼写错误 使用更简单、更常用的词来保持清晰,例如 delete 而不是 remove 如果你使用的资源与其他 API 使用的资源相同,请使用相同的术语以保持一致。 对集合使用复数形式(例如:authors、books 等)。
- RESTful 接口 -
创建数据 Create 读取数据 Read 更新数据 Update 删除数据 Delete
- API 版本控制 -
- 了解主要和次要更新 -
https://api.domain.com/v1.0/authors
https://api.domain.com/2020-06-15/authors
https://api.domain.com/authors
x-api-version:v1
- 分页 -
STRING page_token(在请求中发送) STRING next_page_token(由 API 返回) INT page_size(在请求中发送)
作者:Varun Joshi
来源:
https://codeburst.io/best-practices-api-design-61d4697d17ff
评论
三里乡枫香树村
2022年3月,湖北省生态环境保护委员会命名枫香树村为2022年度湖北省生态村。枫香树村辖区面积4.34平方公里,人口1326人,耕地面积982亩。村干部队伍建设情况:现在村“两委”班子成员5人,村定
三里乡枫香树村
0
枫香树属
枫香树属(学名:LiquidambarL.)是枫香科下的一属,以前也被分到金缕梅科。枫香树属主要生长于气候温暖地带。大型落叶乔木,树干挺直,高度可达25-40米。叶掌状开裂,螺旋着生,叶子在秋天变红。
枫香树属
0