目的

通过本章节可以了解到协议与适配器的关系和作用,不会再讲解API套件的创建步骤。

前置条件

  • 在了解协议和适配器之前,请先创建好API套件,因为协议和适配器都是在API套件里创建的。

协议

介绍

协议是API套件里的接口模型定义,包含请求地址、请求方法、请求头、接口参数、返回结果、错误码等等。

创建API协议

点击查看协议

点击创建API协议

完善协议信息

协议信息主要分为:

  1. 基本信息
    基本信息中的协议URL一项,填写规则:
    • 开头必须带/
    • 如果两个/同时出现,会自动替换为一个/
    • 不允许存在/api
    • 同一API套件下,协议URL不能重复。
    • 不允许只填写为/
  2. 请求头
    根据实际需求自定义
  3. 请求参数
    根据实际需求自定义
  4. 返回参数
    根据实际需求自定义

添加完成

添加完成后的协议,可以进行复制。

添加状态码

文档更新时间: 2023-07-30 11:02   作者:伍润源