写点什么

APi设计

0 人感兴趣 · 9 次引用

  • 最新
  • 推荐

使用友好的 API 设计理念

用户头像
agnostic
2023-05-14

大家经常接触API,而且往往会吐槽这个API设计的太难用了,那个AP理解成本提高,某个API有看起来那么不专业,等等。那么,怎样的API设计才是优雅的呢?

https://static001.geekbang.org/infoq/64/642b1dd7ed6bc046f9cc4a6cba434878.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

如何用 Apipost 校验响应结果

我们可以通过 json-schema 预先定义接口的数据返回格式,当接口完成后,我们可以通过匹配 实际响应结果 和 预先定义的接口格式 ,来发现接口问题。如下图:

如何快速完成 API 设计,mock 数据给到前端?

用户头像
不想敲代码
2023-02-02

API设计用于在接口还没开发完成时,预定义接口请求参数和响应期望(Mock),并自动生成 Mock URL,让前端和测试提前进入研发流程。

https://static001.geekbang.org/infoq/2a/2ab85530554a25cee7d94557868a5a5f.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

9 个 REST API 设计的基本准则

用户头像
devpoint
2021-01-27

通常情况下,在项目开发过程中涉及的API设计是采用REST API的模式,但并没有制定一个严格的、可理解的、可扩展的规范,从长远来看,随着项目的不断迭代,特别的在赶工期的情况下,REST API就会出现偏移。因此建议在项目初期就建立严格的API设计规范。

https://static001.geekbang.org/infoq/c6/c6464019fc177198f792c815e77cc9cb.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

编写令人愉悦的 API 接口 (二)

用户头像
Geek_42915f
2020-12-24

制定API接口的规范在设计接口时尤为重要,统一的格式规范会减少联调的难度,也能让后续维护者身心愉悦.在编写接口时,运用适合的参数检验技巧也能提高代码的健壮性.本文将围绕这两点详解一些我的一些经验.

https://static001.geekbang.org/infoq/9d/9d0c561feac0ed1dbe47ec37c5e40956.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

编写令人愉悦的 API 接口 (一)

用户头像
Geek_42915f
2020-12-23

API接口是服务端与客户端沟通的桥梁.较好的API设计能减少客户端与服务端的联调时间,更加关注于自己本身代码的优化与业务层的逻辑.

https://static001.geekbang.org/infoq/80/80bc625e1656f16326569fad48c81004.png?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

API 接口管理平台 YAPI 的搭建

用户头像
Man
2020-07-16

上一篇文章我们聊到API接口设计最佳实践,后面给自己挖了个坑(也算是自我激励吧)。为什么这里要调研YAPI呢?

https://static001.geekbang.org/infoq/dc/dc213e59fbb5d6c3f7310b1632921b45.jpeg?x-oss-process=image%2Fresize%2Cw_416%2Ch_234

API 接口设计最佳实践

用户头像
Man
2020-07-14

最近团队内部在做故障复盘的时候发现有很多故障都是因为接口设计不当导致的,这里我就整理归纳一下在接口设计层面需要注意的地方。

APi设计_APi设计技术文章_InfoQ写作社区