个人觉得一套好的API应该在三个方面做到最好,注意是同时满足而不牺牲任何一个:

1. 精确的实现功能,不多不少;

2. 简洁明了,方便用户使用,不让他们迷糊;

3. 具备良好的可扩展性,遵循open-close原则;

当然最近我又学到一点,API应该易于理解和交流,过于深奥的设计是很容易被抛弃的。

转载于:https://www.cnblogs.com/alphablox/archive/2012/12/01/2797810.html

how to write a good api相关推荐

  1. 淘宝获取单笔订单信息服务端调用API及流程

    淘宝获取单笔交易接口(文档地址):https://open.taobao.com/api.htm?docId=54&docType=2 调用接口所需依赖(文档地址):https://devel ...

  2. rancher部署项目Validation failed in API: Deployment.apps“”must be no more than 63 characters问题原因及解决方法

    Validation failed in API: Deployment.apps "xxxxxxxxxx-x x x x x x x x x" is invalid: [meta ...

  3. RPC 笔记(01)— RPC概念、调用流程、RPC 与 Restful API 区别

    1. 基本概念 PRC 远程过程调用 Remote Procedure Call,其就是一个节点请求另外一个节点提供的服务.当两个物理分离的子系统需要建立逻辑上的关联时,RPC 是牵线搭桥的常见技术手 ...

  4. 通过聚合数据API获取微信精选文章

    思路 在聚合数据申请账号(https://www.juhe.cn/) 通过聚合数据api获取微信精选文章api 通过newspaper库提取相应的文本内容,关于newspaper库的使用方法可以参考这 ...

  5. 使用 JavaCSV api 读取和写入 csv 文件

    使用JavaCSV api 导包 我现在基本上都是Maven构建项目,相信大家也是,就不提供jar包了. <dependency><groupId>net.sourceforg ...

  6. API pytorch tensorflow

    pytorch与tensorflow API速查表 方法名称 pytroch tensorflow numpy 裁剪 torch.clamp(x, min, max) tf.clip_by_value ...

  7. GPT3 api接口调用

    原标题:OpenAI发布GPT3 api调用接口!可处理几乎所有英文问题 大数据文摘出品 作者:牛婉杨.笪洁琼 两周前,OpenAI又放了个大招:GPT3突然放出,其参数量达到1750亿,相当于160 ...

  8. pykafka连接重要使用pykafka,kafka-python的api开发kafka生产者和消费者

    https://pykafka.readthedocs.io/en/latest/api/producer.html 说明文档 </div><h2 class="heade ...

  9. 降维-基于RDD的API

    降维-基于RDD的API • Singular value decomposition (SVD) o Performance o SVD Example • Principal component ...

  10. 通过带Flask的REST API在Python中部署PyTorch

    通过带Flask的REST API在Python中部署PyTorch 在本文中,将使用Flask来部署PyTorch模型,并用讲解用于模型推断的 REST API.特别是,将部署一个预训练的Dense ...

最新文章

  1. CSS实现某元素hover时 所有兄弟节点样式改变
  2. 【AI初识境】如何增加深度学习模型的泛化能力​​​​​​​
  3. 满分简便代码——L1-049 天梯赛座位分配 (20分)
  4. linux spinlock/rwlock/seqlock原理剖析(基于ARM64)
  5. android camera滑动,Android怎么实现小米相机底部滑动指示器
  6. linux make乱码,linux乱码
  7. C# -Asp.Net.SignalR.Core之Hub
  8. ecu故障现象_传感器坏了,会导致什么故障现象?
  9. url安全处理函数+php,php常用的url处理函数汇总
  10. shiro设置session超时时间
  11. 传感器模块(光敏电阻/热敏电阻/红外接收管等)介绍及使用
  12. 抚琴成一快-电吉他内录(Zoom G3为例)
  13. PTA 厘米换算英尺英寸
  14. 蓝桥杯赛后总结与反思
  15. 「BJOI 2019」勘破神机
  16. 推荐 - 将多种格式的 Office 文件转换为 PPT 和图片
  17. 解决maya导出FBX出现问题。
  18. 将HQL语句转为sql语句
  19. APICloud平台常用技术点汇总详解
  20. 在U盘下安装ubuntu系统,从U盘启动Linux系统

热门文章

  1. 解决办法:RuntimeWarning: numpy.dtype size changed, may indicate binary incompatibility. Expected 96
  2. 复位BIOS解决电脑启动死机
  3. 相同风格,牛仔裤和青花瓷风行世界
  4. Python pip安装报错及解决办法:is not a supported wheel on this platform
  5. java方法介绍_Java 方法介绍
  6. python treeview控件使用详解_python绘图工具turtle库的使用详解
  7. ssh secure shell client 保存密码_著名的SSH协议
  8. vim 查找替换小结
  9. NGN学习笔记4——软交换中的协议2—Megaco/H.248
  10. COOKIE和SESSION之间的区别以及用法