开发者讨厌你API的十个原因

时间：2023-03-08 16:04:23

PS：原文是PDF(E文)，原书名称：10ReasonsWhyDevelopersHateYourAPI

1、文档的吸引力太弱

解决之道

  1. 采用大图片：示例站点
  2. 文档清晰度：示例站点
  3. 文档易于查找：示例站点
  4. 生动的文档：
    1. Swagger
    2. I/O Docs
    3. 采用RAML(RESTful API 模型语言) RAML官网

2、您的沟通技能需要工作（你不能保证开发者始终被通知到）

解决之道

  1. 使用变更日志：http://developer.github.com/changes/
  2. 使用路线图：https://developers.facebook.com/roadmap/
  3. 采用发布日志：http://techblog.constantcontact.com/api/release-updates
  4. 使用博客（Blog）：http://aws.typepad.com/
  5. 使用论坛（Forum）：http://*.com/questions/tagged/soundcloud
  6. 邮件通知

3、你不能使API使用简单

解决之道

  1. 说明你是做什么的：https://www.twilio.com/voice/api
  2. 支持快速注册：https://manage.stripe.com/register
  3. 使用step1-step2-step3说明使用步骤：示例站点
  4. 提供快速入门手册：https://www.twilio.com/docs/quickstart
  5. 提供免费版或者免费试用版：https://parse.com/plans
  6. 提供丰富的SDK（支持多种开发语言）
  7. 使用GitHub ：https://github.com/OneNoteDev

4、没有提供法律申明

解决之道

  1. 要明确权利与义务：http://500px.com/terms
  2. 编写使用协议：https://www.etsy.com/developers/terms-of-use
  3. 申明越短越好：http://googledevelopers.blogspot.com
  4. 申明要想长远：https://developers.google.com/youtube/terms
  5. 分享你的财富：http://slideshare.net/jmusser

5、你的API不可靠（慢、错误、不可靠）

API会被停运(Outage)、Bug、速率(Rate limit)、变更(包含有计划的变更和未被文档跟踪的变更)、ToS违规、Provider biz change、网络等原因影响。

不要让API返回未知的错误信息，让用户迷惑。

解决之道

  1. 使用状态页：http://status.aws.amazon.com/
  2. 监控API：http://www.apiscience.com
  3. 不要隐藏API的变化，如停运：http://blog.akismet.com

6、没有提供能帮助我调用成功的工具

解决之道

  1. 提供开发者仪表板：https://manage.stripe.com/test/dashboard
  2. 提供 Debug/Log 等日志：示例站点
  3. 提供用于测试的沙盒环境：https://www.twilio.com/user/account
  4. 提供Playground：https://developers.google.com/oauthplayground
  5. 提供测试控制台：https://apigee.com/providers

7、只管销售，但不提供售后服务

解决之道

  1. Evangelists：http://sendgrid.com/developers
  2. Events：https://www.twilio.com/conference
  3. Hackathons
  4. PS：不知道如何翻译，so总结一点，就是提供售后支持。

8、API太复杂了（你使用你自己定制的授权、协议、格式）

解决之道

  1. 使用REST（当前最流行的风格）
  2. 使用JSON格式（XML也还好）
  3. 保持务实：http://apigee.com/about/content/web-api-design

9、你的TTFHW（Time to (your) First Hello World）太长

解决之道

  1. 极好的开发者体验：http://developerexperience.org
  2. 在所有问题修正前，先说“Sorry”

10、你还没有从最好的学习到的

  1. 学习榜样的做法（Twilio,Stripe,GitHub.SendGrid）
  2. 保持进步
  3. 记住一句话：API是旅程，不是目的地

*:first-child {
margin-top: 0 !important;
}

body>*:last-child {
margin-bottom: 0 !important;
}

/* BLOCKS
=============================================================================*/

p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}

/* HEADERS
=============================================================================*/

h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}

h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}

h1 {
font-size: 28px;
color: #000;
}

h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}

h3 {
font-size: 18px;
}

h4 {
font-size: 16px;
}

h5 {
font-size: 14px;
}

h6 {
color: #777;
font-size: 14px;
}

body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
margin-top: 0;
padding-top: 0;
}

a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}

h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
margin-top: 10px;
}

/* LINKS
=============================================================================*/

a {
color: #4183C4;
text-decoration: none;
}

a:hover {
text-decoration: underline;
}

/* LISTS
=============================================================================*/

ul, ol {
padding-left: 30px;
}

ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}

ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}

dl {
padding: 0;
}

dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}

dl dt:first-child {
padding: 0;
}

dl dt>:first-child {
margin-top: 0px;
}

dl dt>:last-child {
margin-bottom: 0px;
}

dl dd {
margin: 0 0 15px;
padding: 0 15px;
}

dl dd>:first-child {
margin-top: 0px;
}

dl dd>:last-child {
margin-bottom: 0px;
}

/* CODE
=============================================================================*/

pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}

code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}

pre>code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}

pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}

pre code, pre tt {
background-color: transparent;
border: none;
}

kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
line-height: 10px;
padding: 1px 4px;
}

/* QUOTES
=============================================================================*/

blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}

blockquote>:first-child {
margin-top: 0px;
}

blockquote>:last-child {
margin-bottom: 0px;
}

/* HORIZONTAL RULES
=============================================================================*/

hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}

/* IMAGES
=============================================================================*/

img {
max-width: 100%
}
-->

相关文章