一个API设计网站

痛定思痛。 2022-08-21 07:54 188阅读 0赞

先看看微博和淘宝的API设计

[http://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI][http_open.weibo.com_wiki_E5_BE_AE_E5_8D_9AAPI]

[http://open.taobao.com/api/api\_list.htm][http_open.taobao.com_api_api_list.htm]

在线编写API的工具

[https://apiary.io/][https_apiary.io]

apiary.io是一个帮助设计API的网站。

API设计时很难得。apiary.io想帮助大家设计漂亮得API。

打开网站

![SouthEast][]

点击看看它时怎么工作得，或者直接用github账号登陆，系统会提示你新建一个项目，并为你初始化了一个API文档。如下图：

![SouthEast 1][]

左边是编写得API文档，基于markdown语法，右边时效果（点击右上角preview弹出）。

文档里包括了API的url，提交和返回的数据，对数据得解释等。

当点击保存后，点击Documentation来到，如下图。

![SouthEast 2][]

右边的Mock Server是这个API得模拟器，可以直接访问并返回刚才文档里定义得数据，我们得API就可以测试了，哇哇。

测试得结果

![SouthEast 3][]

还有一个追踪请求功能，相当靠谱。点击Traffic Inspector可以看到每次请求得情况和每次请求得细节。

![SouthEast 4][]

[http_open.weibo.com_wiki_E5_BE_AE_E5_8D_9AAPI]: http://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI
[http_open.taobao.com_api_api_list.htm]: http://open.taobao.com/api/api_list.htm
[https_apiary.io]: https://apiary.io/
[SouthEast]: /images/20220724/43927cf2f1934fa49217d01680ed57a1.png
[SouthEast 1]: /images/20220724/2af74ff0677b490582c5ccd4581abf14.png
[SouthEast 2]: /images/20220724/9a875070578742039c6c1e48c8380eff.png
[SouthEast 3]: /images/20220724/caf741ed5b5c44e5af17a828ebf4b81b.png
[SouthEast 4]: /images/20220724/c1d08473085e467fab38e49697f9f20d.png

发表评论取消回复

表情：

评论列表（有 0 条评论，188人围观）

还没有评论，来说两句吧...

相关阅读

相关怎么样设计一个高质量的 API 接口？

一、什么是幂等性？对于同一笔业务交易，不管调用多少次，只会成功处理一次。二、幂等性设计我们转账业务为例，来说明一下这个问题，转账接口一定要做到幂等性，否则会出现重复

刺骨的言语ヽ痛彻心扉/ 2024年04月07日 13:38/ 0 赞/ 48 阅读

相关分享一个免费Api小网站

网址:[https://api.66mz8.com/][https_api.66mz8.com] ![在这里插入图片描述][watermark_type_ZmFuZ3poZ

痛定思痛。/ 2022年12月25日 01:48/ 0 赞/ 156 阅读

相关主题 01：如何设计一个好的 API

1. 引言如果说好的 UI 设计可以让用户更容易地使用一款产品，那么，好的 API 设计则可以让其他开发者更高效地使用一个系统的能力。良好的 API 可以很大程度上减轻

冷不防/ 2022年11月20日 10:00/ 0 赞/ 197 阅读

相关一个API设计网站

先看看微博和淘宝的API设计 [http://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI][http_open.weibo.com_w

痛定思痛。/ 2022年08月21日 07:54/ 0 赞/ 189 阅读

相关一个题解网站

[http://www.acmerblog.com/][http_www.acmerblog.com] [http_www.acmerblog.com]: http://w

朴灿烈づ我的快乐病毒、/ 2022年07月10日 09:29/ 0 赞/ 170 阅读

相关如何设计一个牛逼的API接口

在日常开发中，总会接触到各种接口。前后端数据传输接口，第三方业务平台接口。一个平台的前后端数据传输接口一般都会在内网环境下通信，而且会使用安全框架，所以安全性可以得到很好的保护

系统管理员/ 2021年09月18日 06:04/ 0 赞/ 391 阅读

相关设计一个良好的restful风格API

[阅读原文][Link 1] 版本号在 RESTful API 中，API 接口应该尽量兼容之前的版本。但是，在实际业务开发场景中，可能随着业务需求的不断迭代，

柔光的暖阳◎/ 2021年09月15日 05:40/ 0 赞/ 411 阅读

相关如何设计一个牛逼的 API 接口

在日常开发中，总会接触到各种接口。前后端数据传输接口，第三方业务平台接口。一个平台的前后端数据传输接口一般都会在内网环境下通信，而且会使用安全框架，所以安全性可以得到很好的保护

淡淡的烟草味﹌/ 2021年09月02日 04:54/ 0 赞/ 470 阅读

相关如何设计一个简单的网站？

如何设计一个简单的网站？通过SEO的方式创造一个成功的网站，需要具备四个要素：用户需求、网站程序、网站内容、懂SEO运营。今天给大家的讲的内容是有关网站程序的网站设计。...

朱雀/ 2021年06月04日 06:50/ 0 赞/ 510 阅读

相关说说如何设计一个良好的 API

在 RESTful API 中，API 接口应该尽量兼容之前的版本。但是，在实际业务开发场景中，可能随着业务需求的不断迭代，现有的 API 接口无法支持旧版本的适配，此时...

灰太狼/ 2020年04月25日 16:35/ 0 赞/ 831 阅读