精华内容
下载资源
问答
  • 2018-12-04 20:49:00

    接口规范说起来大,其实也就那么几个部分,接口规范、接口管理工具、接口文档编写、开发文档编写。以下将详细介绍,下面进入正文:

    接口规范文档
    具体内容如下:
    一:协议规范
    二:域名规范
    三:版本控制规范
    四:API路径规范
    五:API命名规范
    六:请求参数规范
    七:列表请求特殊规范
    八:返回数据规范
    九:接口文档规范
    十:接口管理工具使用教程
     
    参与编写
    更新日期
    版本
    备注
    AbyssKitty
    2018/04/06
    V1.1.0
    V1.1.0更新日志:
    1. 新增协议规范、域名规范、版本控制规范、列表特殊规范。
    2. 更新接口管理工具使用教程。
    3. 美化排版。
     
    正文:
    一:协议规范
    为进一步确保数据交互安全。正式地址(生产地址)必须遵循HTTPS协议。
    二:域名规范
    每个项目要有且仅有一个自己唯一的域名+端口。在项目配置文件中要添加静态变量专门进行存储。
    如果一个域名满足不了要求,那么就需要再添加一个。
    格式规范如下:
    (java)public static final String URL_BASE = “https://127.0.0.1:8080/”;
    (java)public static final String URL_BASE_SUB = “https://192.168.0.1:8080/”;
    必须以https开头,并以“/”结尾。
    三:API路径规范
    作为接口路径,为了和其他路径完美区分,必须在路径中添加api目录
    格式规范如下:
    (java)public static final String URL_API = “api/”;
    (PHP)php目录是加index.php/api/
    必须以字母开头,并以“/”结尾。
    四:版本控制规范
    项目正式上线后,正式版本要确定接口版本、并备份接口代码。
    为方便管理,需要在接口路径中加入版本号信息。
    格式规范如下:
    (java)public static final String URL_VERSION =”v1/”;
    必须以字母开头,并以“/”结尾。
    更新版本后可以使用v2 v3等、依次递加。
    五:API命名规范
    根据二:域名规范、三:API路径规范、四:版本控制规范。项目中必须在配置文件中增加BaseUrl静态常量。值=三个相加。
    格式规范如下:
    (java)public static final String BASEURL=URL_BASE+URL_API+URL_VERSION;
    具体代码如下:
    BASEURL = [“https://127.0.0.1:8080/api/v1/”]
    BASEURL = [“https://127.0.0.1:8080/api/v1/”]
    BASEURL = [“https://127.0.0.1:8080/api/v1/”]
    重要的事情说三遍。
     
    根据业务需求,可以在v1版本文件夹里创建,一个或者多个接口文件。
    一个的规范:
    这就是一个获取banner的接口。
    多个的规范是根据业务需求来区分:
    新建user文件,里面存放用户级别的操作:如登陆、注册、修改密码等等。
    新建sms文件,里面存放对短信的接口操作:如发送验证码、验证手机号等等。
     
    所以,接口方法文件必须要有自己的规范,命名必须统一使用驼峰命名法或者下划线拼接命名法。举个栗子:(upperCamelCase)(upper_camel_case)。所有接口命名方式,必须遵循如下规范。
    (1)新增方法:如新增一个地址、新增一个联系人。
    命名规范:
    必须以“add”为前缀。例如addAddress
    事例地址: https://127.0.0.1:8080/api/v1/addAddress
    (2)删除方法:如删除一个地址。
    命名规范:
    必须以“delete”为前缀。例如deleteAddress
    事例地址: https://127.0.0.1:8080/api/v1/deleteAddress
    (3)修改方法:如修改一个地址。
    命名规范:
    必须以“updata”为前缀。例如updataAddress
    事例地址: https://127.0.0.1:8080/api/v1/updataAddress
    (4)获取方法:如获取一个地址。
    命名规范:
    必须以“get”为前缀。例如getAddress
    事例地址: https://127.0.0.1:8080/api/v1/getAddress
    (5)获取列表方法:如获取一个地址列表。
    命名规范:
    必须以“get”为前缀、“List”为后缀。例如getAddressList
    事例地址: https://127.0.0.1:8080/api/v1/getAddressList
     
    其他规范:
    发送验证码使用‘send’为前缀、保存一个数据以‘save’为前缀、上传图片以‘uploadImage’为名称等等。
    具体地址就等于(BASEURL+“address/getAddressList”)
    目的:一目了然、降低维护成本。
    六:请求参数规范
    请求方式:公共数据使用get方式请求,私有数据使用post方式请求。尽量全部是用post。
    请求头:请求头根据项目需求添加配置参数。如:accept=‘application/json
    ’等。请求头根据项目需求可以要求传入用户token、app名称版本、唯一验签码等加密数据。
        请求参数:
    根据数据库字段进行命名、保持一致最省事。
    七:列表请求特殊规范
    列表请求,请求参数规范,必须传参:页数和每页个数的字段。并可包含查询等信息。
    1. 列表接口必传字段(分页、使用小写字母)。
    page :页数,从1开始。例如:{ “page”: 1  }
    subnumber : 每页数量。
    2. 列表接口选传字段。
    只要是列表接口、一般情况下都会存在检索条件,例如淘宝商品检索。检索条件为选填。
    后台需进行非空非null判断,选传字段为空为null默认查询全部。有值则需要接收,并进行sql查询。
    规范事例:
    普通列表接口: https://127.0.0.1:8080/api/v1/getBannerList
    (不传page、后台默认返回全部数据)
    (banner接口不需要使用检索条件)
    需检索列表接口: https://127.0.0.1:8080/api/v1/getOrderList
    (不传page、后台默认返回全部数据)
    (Order订单接口需要检索条件,不传就不检索,只进行分页查询)
    (如果有 time price等检索条件,不传就不检索,传了就进行条件查询,并返回相应数据)
    八:返回数据规范
    注:列表数据返回,没有特殊情况的条件下,必须最新数据在上面,依次排序。
    返回事例:
    {
    "list":[],
    "object":{}, //"object":""
    "status":"SUCCESS",
    "message":"我是提示消息",
     ...
    "page":1,
    "subnumber":10,
    }
     
    必选-命名规范:驼峰命名法。
    必选-新增键值规则:名字对应固定的格式(list就是数组[])。
    举个栗子:比如一个"list":[]满足不了需求,那么可以新增一个"map":[]。
    比如一个"object":{"name":"小明"}满足不了需求,那么可以新增一个"details":{"name":"小红"}。名字对应固定的格式,数组就是数组、实体类就是实体类、字段就是字段。不能data在这个接口返回的是实体类、另一个接口又返回数组了。需要特别注意。
     
    必选-list:list列表(数组)为空时显示[]。
    必选-object:实体数据,json键值对。
    必选-status:状态信息=SUCCESS、ERROR等静态变量。
    必选-message:提示消息。(加载成功、)
     
    可选-page:页数(分页查新时使用、显示第几页从一开始)。
    可选-subnumber:每页的格式(分页查询时使用、显示当前页的个数)。
     
    九:接口文档规范
    接口文档需要包含以下部分:
    文档名称。
    版本号。
    编写人。
    编写、修改日期。
    baseUrl地址。
    更新日志。
    接口详情。(详情规范如下)
     
    接口详情编辑规范:
    一个完整的接口需要由以下几部分组成
    1.请求地址 例如:https://127.0.0.1:8080/xxx/xxx/xxx
    2.请求方式 例如:POST、GET等
    3.请求参数 例如:传 id:“1”,name:“小明”
    4.返回参数 例如:{ json... } 【参考上面的接口规范】
    5.返回事例 例如:{ json... }
     
    十:接口管理工具使用教程
    接口管理工具有很多,例如RAP、eolinker等等。
    接口管理工具基本的作用都是用来管理接口的。这里简单介绍eolinker的使用方法。
    使用方法步骤:
    创建接口管理项目。
    邀请开发者同事加入。
    编写接口(接口地址、请求参数及备注、请求方式、返回参数及备注、返回事例、在线测试接口)。
    开发者使用接口。
    过程中灵活配合,接口可以灵活更新。
    完成项目后可以导出接口文档。
     

    1. 查询指定项目属性

    接口功能
    获取制定项目的分类信息

    URL
    http://www.api.com/index.php

    支持格式
    JSON

    HTTP请求方式
    GET

    请求参数
    参数 必选 类型 说明
    name ture string 请求的项目名
    type true int 请求项目的类型。1:类型一;2:类型二 。
    返回字段
    返回字段 字段类型 说明
    status int 返回结果状态。0:正常;1:错误。
    company string 所属公司名
    category string 所属类型
    接口示例
    地址:http://www.api.com/index.php?name=”可口可乐”&type=1

    {
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
    }
    1
    2
    3
    4
    5
    markdown源码如下:


    目录

    1\. 查询指定项目属性接口

    ---

    **1\. 查询指定项目属性**
    ###### 接口功能
    > 获取制定项目的分类信息

    ###### URL
    > [http://www.api.com/index.php](www.api.com/index.php)

    ###### 支持格式
    > JSON

    ###### HTTP请求方式
    > GET

    ###### 请求参数
    > |参数|必选|类型|说明|
    |:----- |:-------|:-----|----- |
    |name |ture |string|请求的项目名 |
    |type |true |int |请求项目的类型。1:类型一;2:类型二 。|

    ###### 返回字段
    > |返回字段|字段类型|说明 |
    |:----- |:------|:----------------------------- |
    |status |int |返回结果状态。0:正常;1:错误。 |
    |company |string | 所属公司名 |
    |category |string |所属类型 |

    ###### 接口示例
    > 地址:[http://www.api.com/index.php?name="可口可乐"&type=1](http://www.api.com/index.php?name="可口可乐"&type=1)
    ``` javascript
    {
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
    }
    ---------------------

    转载于:https://www.cnblogs.com/klb561/p/10066783.html

    更多相关内容
  • 项目名称 项目信息接口模块名称 功能描述 获取项目基本信息整个项目信息模块的接口功能描述 返回说明统一接口返回方式 参数名称 类型 描述 Code String 状态码 200 成功 404 错误 Msg String 信息描述 Data 返回的...
  • vue项目中请求接口封装

    千次阅读 2022-03-21 14:33:06
    vue项目中请求接口封装

    axios的拦截器原理如下所示:

       axios请求的相关代码放置于:src→utils→request.js.   request.js基于axios的封装,便于处理统一处理POAT,GET等请求参数,请求头,以及错误提示信息等。具体可以参考:和服务端进行交互 | vue-element-admin。或者https://github.com/PanJiaChen/vue-element-admin/blob/master/src/utils/request.js

    import axios from 'axios'  //导出一个axios的实例,并且这个实例要有请求拦截器,响应拦截器
    const service = axios.create()      //创建一个axios的实例
    service.interceptors.request.use()  //  请求拦截器
    service.interceptors.response.use() // 响应拦截器
    export default service  //导出axios实例

    为了方便管理维护,我们习惯将所有的网络请求放置于scr→api 目录下统一管理,按照模块经行划分。

    例如以下是一个封装用户模板登录的请求接口:

    在其他组件中调用该登录的接口,步骤如下

    <script>
    // 1. 引入login
    import {login} from "@/api/user";
    
    export default {
      data(){
        return{}
      },
      methods: {
        async LoginBut() {
     // 2. 调用接口login
          cosnt{data}=await login()
        } 
      }
    }
    </script>

    展开全文
  • RESTFul API 接口文档模板

    万次阅读 多人点赞 2019-01-13 16:01:08
    修订记录 发布日期 修改说明 2019-01-01 第一次发布 ...若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 时间与日期 日期与时间的表示有多种方式。为统一起见,除非是约定俗...

    修订记录

    发布日期修改说明
    2019-01-01第一次发布

    说明

    排版约定

    排版格式含义
    < >变量
    [ ]可选项
    { }必选项
    |互斥关系
    等宽字体Courier New屏幕输出

    编码

    若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。

    时间与日期

    日期与时间的表示有多种方式。为统一起见,除非是约定俗成或者有相应规范的,凡需要日期时间表示的地方一律采用UTC时间,遵循ISO 8601,并做以下约束:

    1. 表示日期一律采用YYYY-MM-DD方式,例如2016-06-01表示2016年6月1日
    2. 表示时间一律采用hh:mm:ss方式,并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
    3. 凡涉及日期和时间合并表示时,在两者中间加大写字母T,例如2016-06-01T23:00:10Z表示UTC时间2016年6月1日23点0分10秒

    发送请求

    共有三种方式可以基于已构建好的请求消息发起请求,分别为:

    • cURL

      cURL是一个命令行工具,用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端,可以发送HTTP请求给服务端,并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/

    • 编码

      通过编码调用接口,组装请求消息,并发送处理请求消息。

    • REST客户端

      Mozilla、Google都为REST提供了图形化的浏览器插件,发送处理请求消息。针对Firefox,请参见FirefoxREST Client;针对Chrome,请参见Postman

    API 规格

    公共请求消息头

    下表列出了所有 XXX API 所携带的公共头域。HTTP 协议的标准头域不再这里列出了。

    消息头(Header)是否必须说明
    Content-Type可选application/json; charset=utf-8

    公共响应消息头

    下表列出了所有 XXX API的公共响应头域。HTTP协议的标准响应头域不再这里列出了。

    消息头(Header)说明
    Content-Type只支持JSON格式,application/json; charset=utf-8

    错误返回格式

    XXX 错误响应符合BCE规范,统一为如下格式。后续各接口不再单独列出。

    参数名类型说明
    codestring错误码
    messagestring错误描述
    bodystring本次请求的体

    示例

    {
        "code" : "AccessDenied",
        "message" : "Access denied.",
        "body" : ""
    }
    

    其中,code为错误码,所有错误码取值来源 XXX 公共错误码和 XXX 专有错误码。

    公共错误码

    错误码错误描述HTTP 状态码中文解释英文解释

    错误码

    参考各接口错误码。

    接口说明

    接口简介

    依次列出所有接口

    类型子类型说明

    接口调用流程

    说明接口使用流程

    XXXX

    描述

    对接口的描述

    URI

    POST /v1/{id}/user

    Path 参数

    参数说明

    query 参数

    参数是否必须描述

    请求消息头

    除公共消息头外,无其它特殊消息头。

    参数说明是否必须示例

    请求参数体

    参数名称类型描述是否必须
    resultxxx对取值范围,约束,说明,示例的描述

    注:类型部分,如果是一个对象,可以在用 xxx 字段数据结构 在下面表格说明

    xxx 字段数据结构说明

    参数类型描述是否必选

    返回消息头

    除公共消息头,无其它特殊消息头。

    参数说明是否必须示例

    返回参数

    参数名称类型描述
    subnetsList xxx子网列表

    xxx 字段数据结构说明

    参数是否必选参数说明描述

    错误码

    HTTP 状态码错误码错误描述中文解释英文解释建议措施

    请求示例

    URI
    
    Header
    
    Body
    

    应答示例

    Status
    
    Header
    
    Body
    

    参考

    华为公有云 API 接口

    https://support.huaweicloud.com/api-ecs/zh-cn_topic_0065792793.html

    https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020805967.html

    https://support.huaweicloud.com/api-cci/cci_02_3002.html

    附录

    通用请求返回值

    • 正常

      返回值说明
      200请求成功。
      202任务提交成功,当前系统繁忙,下发的任务会延迟处理。
      204任务提交成功。
    • 异常

      返回值说明
      300 multiple choices被请求的资源存在多个可供选择的响应。
      400 Bad Request服务器未能处理请求。
      401 Unauthorized被请求的页面需要用户名和密码。
      403 Forbidden对被请求页面的访问被禁止。
      404 Not Found服务器无法找到被请求的页面。
      405 Method Not Allowed请求中指定的方法不被允许。
      406 Not Acceptable服务器生成的响应无法被客户端所接受。
      407 Proxy Authentication Required用户必须首先使用代理服务器进行验证,这样请求才会被处理。
      408 Request Timeout请求超出了服务器的等待时间。
      409 Conflict由于冲突,请求无法被完成。
      500 Internal Server Error请求未完成。服务异常。
      501 Not Implemented请求未完成。服务器不支持所请求的功能。
      502 Bad Gateway请求未完成。服务器从上游服务器收到一个无效的响应。
      503 Service Unavailable请求未完成。系统暂时异常。
      504 Gateway Timeout网关超时。
    状态码编码状态说明
    100Continue继续请求。这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。
    101Switching Protocols切换协议。只能切换到更高级的协议。例如,切换到HTTP的新版本协议。
    201Created创建类的请求完全成功。
    202Accepted已经接受请求,但未处理完成。
    203Non-Authoritative Information非授权信息,请求成功。
    204NoContent请求完全成功,同时HTTP响应不包含响应体。在响应OPTIONS方法的HTTP请求时返回此状态码。
    205Reset Content重置内容,服务器处理成功。
    206Partial Content服务器成功处理了部分GET请求。
    300Multiple Choices多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。
    301Moved Permanently永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。
    302Found资源被临时移动。
    303See Other查看其它地址。使用GET和POST请求查看。
    304Not Modified所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。
    305Use Proxy所请求的资源必须通过代理访问。
    306Unused已经被废弃的HTTP状态码。
    400BadRequest非法请求。建议直接修改该请求,不要重试该请求。
    401Unauthorized在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
    402Payment Required保留请求。
    403Forbidden请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
    404NotFound所请求的资源不存在。建议直接修改该请求,不要重试该请求。
    405MethodNotAllowed请求中带有该资源不支持的方法。建议直接修改该请求,不要重试该请求。
    406Not Acceptable服务器无法根据客户端请求的内容特性完成请求。
    407Proxy Authentication Required请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。
    408Request Time-out服务器等候请求时发生超时。客户端可以随时再次提交该请求而无需进行任何更改。
    409Conflict服务器在完成请求时发生冲突。返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。
    410Gone客户端请求的资源已经不存在。返回该状态码,表明请求的资源已被永久删除。
    411Length Required服务器无法处理客户端发送的不带Content-Length的请求信息。
    412Precondition Failed未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。
    413Request Entity Too Large由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
    414Request-URI Too Large请求的URI过长(URI通常为网址),服务器无法处理。
    415Unsupported Media Type服务器无法处理请求附带的媒体格式。
    416Requested range not satisfiable客户端请求的范围无效。
    417Expectation Failed服务器无法满足Expect的请求头信息。
    422UnprocessableEntity请求格式正确,但是由于含有语义错误,无法响应。
    429TooManyRequests表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。
    500InternalServerError表明服务端能被请求访问到,但是不能理解用户的请求。
    501Not Implemented服务器不支持请求的功能,无法完成请求。
    502Bad Gateway充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。
    503ServiceUnavailable被请求的服务无效。建议直接修改该请求,不要重试该请求。
    504ServerTimeout请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。
    505HTTP Version not supported服务器不支持请求的HTTP协议的版本,无法完成处理。

    任务类接口

    • 正常响应要素说明

      名称参数类型说明
      job_idString提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态,请参考查询Job状态。
    • 异常响应要素说明

      名称参数类型说明
      error字典数据结构提交任务异常是返回的异常信息,详情请参见 error 数据结构说明。

      error 数据结构说明

      名称参数类型说明
      messageString任务异常错误信息描述。
      codeString任务异常错误信息编码。
    • 响应样例

      正常响应:

      { 
          "job_id": "70a599e0-31e7-49b7-b260-868f441e862b", 
      } 
      

      异常响应:

      { 
          "error": {"message": "", "code": XXX}
      } 
      

    批量接口

    • 正常响应要素说明

      名称参数类型说明
      response列表数据结构提交请求成功后返回的响应列表,详情请参见下面response数据结构说明。

      response数据结构说明

      名称参数类型说明
      idString操作成功的虚拟机id
    • 异常响应要素说明

      名称参数类型说明
      error字典数据结构批量请求异常时返回的整体异常信息,详情请参见 error 数据结构。
      internalError列表数据结构批量请求处理中,每一个单个请求的具体异常信息,详情请参见 internalError 数据结构说明。

      error 数据结构说明

      名称参数类型说明
      messageString批量操作整体异常错误信息描述。
      codeString批量操作整体异常错误信息编码。

      internalError 数据结构说明

      名称参数类型说明
      idString具体单个请求操作失败的虚拟机id
      error_messageString具体单个请求操作失败的错误信息描述。
      error_codeString具体单个请求操作失败的错误信息编码。
    • 响应样例

      正常响应:

      { 
          "response": [
                        {
                          "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"   
                        },
                        {
                          "id": "516fb98f-46ca-475e-917e-2563e5a8cd12"   
                        }
                     ]
      }
      

      异常响应:

      {
           "error": {
                       "code": "Ecs.xxxx",
                       "message": "xxxxxxxxxxxxxxx" 
                     },
           "internalError": [
                       {
                          "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
                          "error_code": "ECS.XXXX",
                          "error_message": "xxxxxxxxxxxxxxx" 
                        },
                       {
                           "id": "516fb98f-46ca-475e-917e-2563e5a8cd12",
                           "error_code": "ECS.XXXX",
                           "error_message": "xxxxxxxxxxxxxxx" 
                       }
                    ]
      }
      
    展开全文
  • 文章目录动态拼装请求参数使用全局变量 动态拼装请求参数 定义一个data.json文件,存放请求参数,格式 [{ "id": "8B47A1FF-F2C2-4066-91D3-178D076097A1" },{ "id": "8B47A1FF-F2C2-4066-91D3-178D076097A1...

    动态拼装请求参数

    1. 定义一个data.json文件,存放请求参数,格式
    [{
    		"id": "8B47A1FF-F2C2-4066-91D3-178D076097A1"
    		},{
    		"id": "8B47A1FF-F2C2-4066-91D3-178D076097A1"
    }]
    
    1. postman调用方式{{id}}
      在这里插入图片描述
    2. 打开run-collection runner,选择刚才定义的data.json文件
      在这里插入图片描述
      Iterations:循环次数
      Delay: 循环间隔
      Data:参数模板文件
      Data File Type:按照自己定义的格式选择即可,编者是使用的application/json
      Preview: 可以预查询以下data.json的数据
      设置完以上参数,直接Run Test 即可

    使用全局变量

    在使用Postman调用接口的时候,会遇到类似token的参数,只需要在一个地方统一配置即可,不需要在每个接口里面单独配置,要是接口多的话,一个一个的配置,会累屎的。这个使用就用到全局变量功能

    1. 点击接口右上角的锯齿状的按钮,里面可以设置全局变量,如下图,调用使用{{自定义参数名}}即可
      在这里插入图片描述
    展开全文
  • 在flask-restplus下统一接口返回格式

    千次阅读 2020-07-04 17:12:03
    在flask-restplus下统一接口返回格式 背景 在使用flask+flask-restplus时,业务正常时接口函数返回一个可以json序列化的对象 @ns.route('/hello') class Hello(Resource): def get(self): return ['hello', 'hi'] ...
  • SpringMVC请求参数接收总结

    千次阅读 2018-08-07 09:51:22
    在日常使用SpringMVC进行开发的时候,有可能遇到前端各种类型的请求参数,这里做一次相对全面的总结。SpringMVC中处理控制器参数的接口是HandlerMethodArgumentResolver,此接口有众多子类,分别处理不同(注解类型)...
  • 文章目录构建FeignClient接口实现动态url带参数请求带动态参数请求下载文件的请求请求体的请求 官方使用文档:链接 构建FeignClient接口实现 public static final <T> T getFeignClient(Class<T> ...
  • 请求参数型注解 1、组件型注解 2、请求参数型注解 2.1 @RestController 2.2 @RequestMapping 2.3 @PathVariable 2.4 @RequestParam 2.5 @RequestBody 3、总结 前言 SpringBoot的MVC 支持主要来自于实地项目开发...
  • https://gitee.com/xxssyyyyssxx/httpclient ... 我们项目中可能会使用很多的http请求的库,比如URLConnection、ApacheClient、OkHttp库等。每个库的操作方式都不一样,这是一个巨大的困扰。如果需要换...
  • 如何在Angular优雅编写HTTP请求

    千次阅读 2020-12-19 19:14:58
    一个良好的后端会通过一套所有前端都通用的 RESTful API 序列接口作为前后端之间的通信。这其中对于身份认证都不可能再依赖传统的Session或Cookie;转而使用诸如OAuth2、JWT等这种更适合API接口的认证方式。当然本文...
  • 前提在日常使用SpringMVC进行开发的时候,有可能遇到前端各种类型的请求参数,这里做一次相对全面的总结。SpringMVC中处理控制器参数的接口是HandlerMethodArgum...
  • 接口文档如何写

    千次阅读 2021-07-14 00:52:00
    最近看了很多写的非常好的接口文档,在理解业务方面给了非常多的帮助,解决很多时候对于一些协商数据的问题困扰,同时,后续个人的工作当中,也需要对外开放接口给第三方进行调用,这时候一个好的规范文档可以解决很...
  • ***前台通过url请求数据接口后取得的日期都比数据库数据少一天 查阅分析后问题原因: java从数据库取得的日期格式为CST,而在前台取出后被解析为UTC格式,在中国时区,两者足足差了八小时,去除显示时间,刚好相差一...
  • Nginx + Lua 请求解析并转发请求

    千次阅读 2020-10-19 23:35:13
    关键词: nginx + lua 脚本 lua 获取 http 请求参数 ...用 nginx 向外提供统一接口,在 nginx 内用 lua 脚本获取请求参数,根据参数中的平台信息将请求发送给不同的平台。 具体实现: 在 CentOS7 服务器上安装
  • vue-resouce设置请求头的三种方法

    千次阅读 2020-12-29 17:48:46
    vue-resouce设置请求头的三种方法本文主要介绍了vue-resouce设置请求头的三种方法,分享给大家,具体如下:第一种:在Vue实例中设置var vm = new Vue({el:'#rrapp',data:{showList: true,title: null},...
  • uni-app 网络请求

    千次阅读 2020-08-05 21:58:19
    uni-app 网络请求 uni-app中的网络请求是通过 uni 这个对象中的request({ })来完成的,类似于微信小程序中通过 wx.request({ }) 来完成网络请求 ... 开发者服务器接口地址 data Ob...
  • 在日常开发中,我们总会写各种各样的接口,尤其是在移动互联网,分布式、微服务盛行的当下,绝大部分项目都采用的微服务框架和前后端分离方式来开发,后端工程师能写出优雅接口代码无疑是前端工程师的一个福音,一个...
  • 文章目录一、返回值格式统一1.返回值介绍2.基础类功能3.基础实现4.测试信息二、附录说明 一、返回值格式统一 1.返回值介绍 在使用controller对外提供服务的时候,很多时候都需要统一返回值格式,例如 { ...
  • 微信小程序开发 - 模板与配置

    千次阅读 2022-03-17 17:37:35
    文章目录一、wxml 模板语法1、数据绑定2、事件绑定3、事件传参与数据同步4、条件渲染 wx:if5、列表渲染 wx:for二、wxss1、rpx 尺寸单位2、样式导入3、全局、局部样式三、全局配置1、window2、tabBar四、页面配置五、...
  • 前端规范——前后端接口规范

    千次阅读 2021-11-30 17:17:59
    通用要求 接口命名小驼峰 如果不是restfull的接口,需要语义化,例如:getUserInfo、...对前端的要求:前端使用axios统一封装请求方法,做统一请求、拦截 安全性要求 如果是客户敏感信息,接口绝对需要返回最小
  • 微信新更新的sendUniformMessage接口也叫下发小程序和公众号统一的服务消息,可以支持小程序服务通知和微信公众号模板消息的发送,并且如果小程序与公众号相互关联还可根据通知进行页面的跳转交互,好吧 话不多说...
  • php 写http请求接口供第三方平台调用

    千次阅读 2018-07-19 16:32:11
    接口参数要求 传递过来的参数为json格式。如: { "code": "XXXX_接口创建的验证码", "status": "rejected", "remarks": "模板内容不符合规范,...
  • 后续我只有提供地址和请求参数就可以发起接口访问 2.我写一个读取文件的类,准备用于处理文件相关,现在只有读取yaml问的方法,后续准备写读取execl、execl和yaml用例数据转换,用例数据处理。 方法测试: 3.环境...
  • Jmeter快速上手之接口测试

    千次阅读 2021-11-17 14:33:44
    压测工具 Jmeter 除了可以做性能测试,还可以做接口测试。当接口测试趋向于自动化方向时,就可以使用很典型的接口自动化测试框架 Jmeter + Ant + Jenkins。 本篇将讲解如何快速使用Jmeter来进行接口测试。
  • SprinBoot:简述SpringBoot控制层的统一异常处理(Rest接口) 《 SprinBoot:简述SpringBoot控制层的统一异常处理(错误页面) 》 《 SprinBoot:简述SpringBoot控制层的统一异常处理(Rest接口) 》  实际...
  • 接口测试基础

    千次阅读 2021-09-24 08:58:05
    接口测试基础
  • 外部接口调用失败重试

    千次阅读 2021-01-20 10:58:53
    文章目录@[toc]第三方接口调用失败重试规则代码`@MyRetry``MyRetryFactory``MyRetryTemplate``ResponseResult``ThirdCallService``ThirdCallServiceImpl``Tester`结果总结 第三方接口调用失败重试 规则 第三方接口...
  • 企信通短信平台接口文档

    千次阅读 2018-10-27 15:08:51
    客户接口说明 客户接口说明 1 第一章 发送接口 2 1.1 请求地址 2 1.2参数说明 2 1.3返回值 2 第二章 余额及已发送量查询接口 3 2.1 请求地址 3 2.2参数说明 3 2.3返回值 3 第三章 非法关键词查询 4 3.1 请求地址 4 ...
  • 在postman中完成配置环境(开发环境、测试环境和生成环境)、接口关联、参数设置 一、环境配置 通过postman的环境变量完成自动化配置 ...在获取接口统一鉴权码token接口请求页的Tests设置json提取器

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 49,726
精华内容 19,890
关键字:

统一接口请求参数模板