美文网首页
2018-10-30接口规范&接口入门

2018-10-30接口规范&接口入门

作者: 凡星点点5 | 来源:发表于2018-10-31 20:41 被阅读0次

熟悉项目业务流程

14245353-40d8006ad984a30b.png

一、编写报文

  1. 编写XML
    使用notepad++根据接口规范编写xml请求正文
  • XML 指可扩展标记语言。
  • XML 是一种标记语言,类似HTML。
  • XML 的设计宗旨是传输数据,而非显示数据。
  • XML 标签没有被预定义,需要自行定义标签。
  • XML 被设计为具有自我描述性。
  • XML 是W3C的推荐标准
14245353-6fca948cc1a7fb12.png

接口规范

  1. 接口规范的类型
    1. 离线文档分类
  • word文档
  • pdf文档
  • excel 文档
  1. 在线文档分类
  • swagger
  1. 各种文档详解
  • word文档
    优点:可以和excl或者viso进行集成
    缺点:不能及时更新
  • swagger
    优点:接口规范是根据接口实时更新的,能够自动生成请求,有浏览器就能测试。
    没有接口规范,开发必须要提供请求报文模板。
  1. word文档内容详解
  • 通配符
    ? 表示0..1,可选项
  • 表示0..n,可以没有,也可以有多项
  • 表示1..n,至少有1项,也可以有多项
    1 表示必须且只能填1项
14245353-d19a3f2ccac5f634.png
  • 字段的限制条件
    定长 Fx表示数据是指定x位长的。
    变长 Vx表示数据是变长的,最长为x位长。


    14245353-829494304382369f.png
  • 接口属性(服务属性)
    1.协议名
    2.请求方法
    3.同步/异步
    4.编码格式
    5.数据格式
    6.资源路径


    接口属性.png
  • 响应报文

2. swagger详解

  • 请求方法
  • 资源路径
  • 请求报文
  • 响应报文

字段约束条件

  • string 字符串
  • nteger 数字
  • optional 可选
  • require 必选
  • 数据格式
14245353-e89119a5985c1805.png
14245353-9c44163bb5a26a97.png
14245353-96ea516be95f6cea.png
14245353-0440bcdd007dbbd3.png 14245353-46c256a473c2a2b5.png

2. 编写json

  • JSON 语法规则
  • JSON 语法是 JavaScript 对象表示法语法的子集。
  • 数据在名称/值对中
  • 数据由逗号分隔 ,
  • 花括号保存对象 { }
  • 方括号保存数组 [ ]


    14245353-48ae65929d82c9b3.png

1. XML格式

<request>
    <customer>
        <customerName>zhouxiong</customerName>
        <cstType>1</cstType>
        <headPortrait></headPortrait>
        <cert>123456789987654321</cert>
        <addr></addr>
        <contacInfo>
            <phone>12345678911</phone>
            <weichat>zhou</weichat>
            <qq></qq>
            <email></email>
            <SpareContact>
                <name></name>
                <phone></phone>
            </SpareContact>
        </contacInfo>
    </customer>
</request>

2. json格式

{
  "request": {
    "customer": {
      "customerName": "zhouxiong",
      "cstType": "1",
      "cert": "123456789987654321",
      "contacInfo": {
        "phone": "12345678911",
        "weichat": "zhou",
        "SpareContact": {
          
        }
      }
    }
  }
}

二、 swagger查看接口规范

1. 简介

swagger是一个java第三方jar,集成到项目后,可以通过注解,对接口代码进行描述,启动项目后会自动根据代码和注解生成在线实时接口规范,同时还有测试功能。

2. 内容

14245353-01f6d513ca50c365.png
  1. 测试接口
    fiddler抓包
    填键值对的参数
    填json的参数
    发送请求
    查看结果
  2. 参数类型 parameter type
    类型 描述
    path 资源路径带参数
    query get请求的键值对参数
    body post请求的正文
  • body类型
    细项 用途
    Model 描述字段
    Model Schema 提供报文模板,点击自动填写
  • path类型
14245353-483a878c7fe16138.png
  • qurey类型


    14245353-151d5ff23f2d4a86.png
  • body


    14245353-712911ab09835d9a.png

三、 接口测试流程

14245353-2f2161546726863c.png
14245353-c10d74d0e112696c.png

相关文章

网友评论

      本文标题:2018-10-30接口规范&接口入门

      本文链接:https://www.haomeiwen.com/subject/bvrztqtx.html