跳至主要內容

API模块

holic-x...大约 2 分钟

API模块

1.系统设计

​ 核心业务流程:

  • 管理员:管理接口信息、发布、下线接口

  • 用户:在线调试,可以以开发者身份介入系统

    • 接口提供方:自行编写接口服务=》网站申请上线接口=》管理员审核=》可供其他用户调用(提升网站贡献度)

    • 接口调用方:方式1:通过在线调试进行调用;方式2:开发者身份介入:下载系统提供的SDK快速接入=》通过AK/SK编写程序调用

​ API模块构建的核心是API信息管理和API调用,其中API信息管理是基于API接口信息的CRUD相关操作,API调用则是基于服务调用的实现,提供一个在线调用的入口让用户可以访问到网站上的API。具象化到具体实现,每块的内容都有可扩充的点:

1)自定义SDK:提供鉴权参数封装等公共方法,让开发者可以通过一行代码快速调用服务接口(对比传统编写代码实现和SDK应用)

2)网关的引入:引入网关进行服务转发、网关限流、服务端统一鉴权、数据染色、通用处理(接口调用次数统计等)

3)RPC的引入:由于网关中的部分实现涉及到数据库交互,需要依赖一些数据库操作,对比方案选择RPC调用后台服务接口实现来完成数据库操作(传统代码编写=》HTTP服务调用=》RPC服务调用,一步步进阶分析)

4)数据统计:当基础信息构建完成,则可进行数据统计

5)扩展:接口服务限流、如何进一步提升接口响应性能、如果接口调用失败对应的接口调用次数如何处理?

模块介绍说明
后台核心:接口信息管理、审核、数据统计
1)接口信息管理接口信息管理(CRUD)、接口调用次数控制(访问限流)、针对用户自主提交的接口提供审核机制
2)接口信息统计统计接口调用情况、调用排行等
前台核心:接口检索(聚合搜索嵌入)、开发者模式介入
1)接口广场检索接口信息
2)我的接口用户可以以开发者的模式提供接口,也可以作为接口调用方申请调用接口

2.系统实现

参考:在系统中继承天气预报服务open in new window

评论
  • 按正序
  • 按倒序
  • 按热度
Powered by Waline v3.1.3