API Design Guide

[hhstore]

related:

• Tools: API Design #42 : api design tool
• API Design: GraphQL #68 : graphql api

[hhstore]

API 设计规范:

Google:

• https://cloud.google.com/apis/design/

API 参数字段定义规范:

• https://cloud.google.com/apis/design/standard_fields

API 命名规范:

• https://cloud.google.com/apis/design/naming_convention

项目目录命名规范:

• https://cloud.google.com/apis/design/directory_structure

HTTP 规范:

• https://cloud.google.com/apis/docs/http

Errors

• https://cloud.google.com/apis/design/errors
• HTTP 错误码

[hhstore]

设计良好的API:

Restful API:

• https://developer.gitter.im/docs/rest-api
• https://api.plot.ly/v2/
• github v3: https://developer.github.com/v3/
• 淘宝: https://open.taobao.com/docs/api_list.htm?spm=a219a.7629065.0.0.IxTQKH&cid=1
• 蚂蚁金服: https://docs.open.alipay.com/api
  • 支付相关的API设计, 命名, 参数, 校验规则等.
• 七牛云 Python SDK: https://developer.qiniu.com/kodo/sdk/1242/python
• 美团: http://developer.waimai.meituan.com/home/doc/food/1

GraphQL API:

• https://developer.github.com/v4/
• https://developer.github.com/v4/guides/intro-to-graphql/

[hhstore]

django rest:

• https://github.com/rosarior/awesome-django#restful-api

• https://github.com/funkybob/django-nap/

  • 类似 drf, 但是设计的感觉比drf 更干净

• https://github.com/toastdriven/restless/

  • 这个项目看起来很干净.