首页 > 其他分享 >接口的概念和接口文档

接口的概念和接口文档

时间:2023-02-01 14:44:39浏览次数:43  
标签:调用 包含 URL 接口 概念 参数 文档

使用 Ajax 请求数据时,被请求的 URL 地址,就叫做 数据接口(简称接口)。同时,每个接口必须有请求方式。

 

 接口文档,顾名思义就是 接口的说明文档它是我们调用接口的依据。好的接口文档包含了对 接口URL参数 以及 输出内容 的说明,我们参照接口文档就能方便的知道接口的作用,以及接口如何进行调用

接口文档的组成部分

接口文档可以包含很多信息,也可以按需进行精简,不过,一个合格的接口文档,应该包含以下6项内容,从而为接口的调用提供依据:

  • 接口名称:用来标识各个接口的简单说明,如 登录接口获取图书列表接口

  • 接口URL:接口的调用地址

  • 调用方式:接口的调用方式,如 GET 或者 POST

  • 参数格式:接口需要传递的参数,每个参数必须包含 参数名称参数类型是否必选参数说明 这4项内容

  • 响应格式:接口的返回值的详细描述,一般包含数据名称数据类型说明3项内容

  • 返回示例(可选):通过对象的形式,列举服务器返回数据的结构

 

 

 

标签:调用,包含,URL,接口,概念,参数,文档
From: https://www.cnblogs.com/harryzong/p/17082526.html

相关文章

  • JavaScript闭包的概念
    什么是闭包?闭包有什么作用,缺点是什么?闭包的概念:JavaScript中函数会产生闭包(closure)。闭包是函数本身和该函数声明时所处的环境状态的组合;函数能够“记忆住”其定义......
  • Python-接口
    fromabcimportABCMeta,abstractmethod#接口:若干抽象方法的集合classPaymet(metaclass=ABCMeta):#abstractmethodclass#抽象方法@abstractmeth......
  • web相关概念回顾、服务器软件_概述
    web相关概念回顾软件架构:C/S:客户端/服务器端B/S:浏览器/服务器端资源分类:静态资源:所有用户访问相同资源后,得到的结构都是一......
  • OpenWRT Dnsmasq在指定接口上工作
    设置如下dnsmasq默认在loopback上工作configdnsmasq'landomain'   optiondomainneeded'1'   optionboguspriv'1'   optionfilterwin2k'0'   optio......
  • 企业的内部文档太杂乱,有什么好用的文档管理软件?
    企业内部文档的管理,是一个老生常谈的问题。有些企业的文档管理比较混乱,很难做好企业内部的信息管控。我们可以先从以下几个方面入手:企业内部文档杂乱分散,集中式的管理;信......
  • 接口
    1.普通类:只有具体实现抽象类:具体实现和规范(抽象方法)都有!接口:只有规范!自己无法写方法~专业的约束!约束和实现分离:面向接口编程~2.接口就是规范,定义的是一组规则。3.接口......
  • Nosql基本概念
    Nosql基本概念一、为什么使用Nosql1、单机Mysql时代90年代,一个网站的访问量一般不会太大,单个数据库完全够用。随着用户增多,网站出现以下问题数据量增加到一定程度,单机数据......
  • 看看人家那后端API接口 转载
    文章来源:https://www.toutiao.com/article/6694404645827117572/?group_id=6694404645827117572 目录前言接口交互返回格式控制层Controller美观美化优雅优化实......
  • Go使用post方法将json数据传给一个url(后端接口)
       最近做的一个项目是采用前后端分离模式写前端,后端是fabric区块链,提供接口,需要使用post方法进行访问。如上一章注册用户,就是需要把用户名、账户信息转换成json形式......
  • react官方文档-高级部分-Render Props学习(重要)
    前言:术语“renderprop”是指一种在React组件之间使用一个值为函数的prop共享代码的简单技术 具有renderprop的组件接受一个函数,该函数返回一个React元素并......