API 实战(14)分析输入和输出

分享
程序员 2024-9-3 19:57:11 59 0 来自 中国
在上一篇文章中,我们通过两个题目(做什么?和怎么做?),分析出用户利用软件的目的和 API 要告竣的目的,得到了开端的计划效果。本文将继续完满我们的 API 计划方案,探究 API 的输入和输出。
输入和输出

API 在告竣目的时,大概需要用户提供须要的信息。比方,你要查察的自行车。API 在完成工作后,应该返回用户需要的信息,比方,一辆自行车的详细形貌,车子的高清图片大概骑行视频展示等。
通过下面两个题目,对 API 的输入和输出举行分析:

  • API 需要什么?
  • API 返回什么?
添加商品到购物车

用户在把自行车添加到购物车时,需要什么才气完成这一目的呢?很显然,我们需要告诉 API,要添加的物品:自行车,以及要添加到那边:购物车。
添加完成后,用户盼望得到什么呢?你大概会想,需要一个乐成的消息。这里我们临时不思量这些一样平常性的信息,每一个 API 都会返回类似的信息,在这里,我们更多关注业务干系的内容。在添加乐成后,不需要返回更多信息。
结算购物车中商品

用户在结算购物车产物时,需要什么才气完成这一目的呢?购物车,要结算的商品也已经在购物车里了。用户需要得到什么呢?用户固然需要得到一份条约,也就是订单。
效果

继续完满我们的计划效果。
小结

我们通过两个题目:需要什么?和得到什么?,进一步找出 API 在告竣目的时,需要的输入和输出。
在线上购物这个较为认识的场景中,会比力容易的找到题目的答案。如果在更为复杂的场景,题目并不容易答复,你大概担心出现遗漏的环境。
有这种担心非常好,可以促使对题目举行全面和深入的思索。纵然出现遗漏,也没有关系。随着开发的深入,我们对业务也会更加认识;而且每个 API 都不是 是孤立的,在计划其他 API 时,也会引发我们对已经开发完成的 API 的回首。全部这些都会资助我们查漏补缺,渐渐完满 API.
记着:API 的计划不是一次性的工作,在整个 API 的生命周期,不停迭代更新。
您需要登录后才可以回帖 登录 | 立即注册

Powered by CangBaoKu v1.0 小黑屋藏宝库It社区( 冀ICP备14008649号 )

GMT+8, 2024-10-19 15:31, Processed in 0.166961 second(s), 32 queries.© 2003-2025 cbk Team.

快速回复 返回顶部 返回列表