当前位置:   article > 正文

第一章、接口规范之web-api接口

api接口规则

1.什么是Web API接口

通过网络,规定了前后台信息交互规则的url链接,也就是前后台信息交互的媒介

Web API接口和一般的url链接还是有区别的,Web API接口简单概括有下面四大特点

  • url:长得像返回数据的url链接

  • 请求方式:get、post、put、patch、delete

    • 采用get方式请求上方接口
  • 请求参数:json或xml格式的key-value类型数据

    • ak:6E823f587c95f0148c19993539b99295
    • region:上海
    • query:肯德基
    • output:json
  • 响应结果:json或xml格式的数据

    • 上方请求参数的output参数值决定了响应数据的格式

      1. {"status":0,
      2. "message":"ok",
      3. "results":[
      4. {
      5. "name":"肯德基(罗餐厅)",
      6. "location":{
      7. "lat":31.415354,
      8. "lng":121.357339
      9. },
      10. "address":"月罗路2380号",
      11. "province":"上海市",
      12. "city":"上海市",
      13. "area":"宝山区",
      14. "street_id":"339ed41ae1d6dc320a5cb37c",
      15. "telephone":"(021)56761006",
      16. "detail":1,
      17. "uid":"339ed41ae1d6dc320a5cb37c"
      18. }
      19. ...
      20. ]
      21. }

2.接口文档的编写:YApi

YApi是去哪网大前端技术中心的一个开源可视化接口管理平台

YApi项目可以搭建在任何本地或云服务器上,完成后台项目开发时的接口编写。为开发、测试等人员提供可视化的接口预览。

去哪同时在网上提供了YApi的测试网站:http://yapi.demo.qunar.com/,我们可以通过测试网站了解YApi是如何进行接口的编写的

  • 访问测试网站

  • 创建接口项目

  • 创建接口

  • 编写接口

3.接口测试工具:Postman

Postman是一款接口调试工具,是一款免费的可视化软件,同时支持各种操作系统平台,是测试接口的首选工具。

Postman可以直接从官网:https://www.getpostman.com/downloads/下载获得,然后进行傻瓜式安装。

  • 工作面板

  • 简易的get请求

  • 简易的post请求

  • 案例:请求百度地图接口

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/一键难忘520/article/detail/830957
推荐阅读
相关标签
  

闽ICP备14008679号