OpenAPI 设计

REST API 设计 规范 #

OpenAPI Specification 业界标准

  1. A Visual Guide to What’s New in Swagger 3.0
  2. OpenAPI Specification - Version 3.0.2

Google API Design Guide

  1. 谷歌API设计指南

API 设计模式 #

  1. RPC
  2. ROA(Rest-Oriented Architecture)

通常RESTful风格对API设计者的要求是比较高的，主要的难点在于面向资源设计要求开发者事先做好规划，将后端数据模型与API服务模型相匹配。

面向资源设计API #

  • 资源模型 资源分类管理
  • 资源关系

ECS TAG功能详解 资源组

服务容错处理 #

  1. 同步请求的Timeout[2]
  2. 异步请求方式
  3. 错误码
    TagResources 错误码

参考: #

  1. 云服务OpenAPI的7大挑战，架构师如何应对？ 阿里技术 虚明
  2. 超时和重试总结 self