常见JS前端接口校验方式总结

更新时间：2023年05月19日 09:42:46 作者：𝑺𝒉𝒊𝒉𝑯𝒔𝒊𝒏𝒈

作为一名优秀的接口调用工程师，对接口的返回信息进行校验是必不可少的，本文整理的是一些常用的校验方式，希望能够对大家有所帮助

1. 检查返回数据的类型

在接口返回数据中，最基本的校验就是检查返回数据的类型是否符合预期。返回数据类型的判断可以使用JavaScript内置的 typeof 操作符实现。

if (typeof responseData === 'object') {
    // 处理返回结果为对象的情况
} else if (typeof responseData === 'string') {
    // 处理返回结果为字符串的情况
} else if (typeof responseData === 'number') {
    // 处理返回结果为数字的情况
}

这里，我们使用了 typeof 判断数据类型，根据不同的类型来处理和展示结果。

2. 校验返回数据的结构

在确定了返回数据的类型后，接下来需要对接口返回数据的各个字段进行校验。一个常见的方式是使用断言库（如 chai）提供的 expect 语法。

假设我们调用了一个获取商品详情的接口，并期望该接口返回如下结构：

{
    "product_id": "123",
    "name": "iPhone 15",
    "price": 9999,
    "specs": ["256GB", "512GB", "1T"],
    "images": [
        {
            "url": "https://example.com/iphone_15_1.jpg",
            "alt": "iPhone 15 正面照片"
        },
        {
            "url": "https://example.com/iphone_15_2.jpg",
            "alt": "iPhone 15 背面照片"
        }
    ]
}

我们可以这样使用 expect：

const chai = require('chai');
const expect = chai.expect;
describe('Product API', function() {
  it('should return product detail correctly', (done) => {
    // call the API to get produt detail
    api.getProductDetail(123, function(responseData) {
      expect(responseData).to.be.an('object');
      expect(responseData.product_id).to.equal('123');
      expect(responseData.name).to.be.a('string');
      expect(responseData.price).to.be.a('number');
      expect(responseData.specs).to.be.an('array').that.includes('256GB');
      expect(responseData.images[0]).to.have.all.keys('url', 'alt');
      done();
    });
  });
});

在上例中，我们对返回数据的每个字段进行了详细的校验。如果某个字段不符合预期，expect 会抛出一个错误。

3. 校验返回数据的内容

除了校验返回结果的结构外，还需要检查返回数据的具体内容是否正确。例如，当调用注册接口时，需要确保返回结果中是否包含如下信息：

{
    "status": "success",
    "message": "ok",
    "data": {
        "user_id": 123,
        "username": "jackie"
    }
}

我们可以用以下方式进行校验：

assert.equal(responseData.status, 'success');
assert.include(responseData.message, 'ok');
assert.isObject(responseData.data);
assert.isNumber(responseData.data.user_id);
assert.typeOf(responseData.data.username, 'string');

在使用 assert 校验函数时，如果值不符合预期，则会抛出异常。

4. 检查错误码

对于有些业务场景下的接口，可能会返回特定的错误码。这种情况下，需要对错误码进行详细的检查和处理。

以乘客接口为例，返回结果中可能存在以下的错误码：

100001: 请求参数有误
100002: 未查询到该行程信息
100003: 班次已过期，请重新选择
100004: 余票不足
100005: 当前登录状态已失效，请重新登录
100006: 订单已取消或已完成
100007: 订单不存在

针对不同的错误码，我们可以提供相应的错误提示信息，以便用户更好地理解问题所在。

switch (errorCode) {
    case '100001':
        console.log('请求参数有误');
        break;
    case '100002':
        console.log('未查询到该行程信息');
        break;
    case '100003':
        console.log('班次已过期，请重新选择');
        break;
    case '100004':
        console.log('余票不足');
        break;
    case '100005':
        console.log('当前登录状态已失效，请重新登录');
        break;
    case '100006':
        console.log('订单已取消或已完成');
        break;
    case '100007':
        console.log('订单不存在');
        break;
    default:
        console.log('未知错误');
}

在处理错误码时，我们使用了 switch 语句来根据错误码输出相应的错误提示信息。

5. 防止XSS攻击

由于恶意脚本注入可能会造成 XSS 攻击，因此需要对接口返回的数据进行过滤和转义处理。

假设有如下代码：

const data = JSON.parse(responseData);
document.getElementById('content').innerHTML = data.content;

当接口返回的内容为 <script>alert('XSS')</script> 时，就有可能触发 XSS 攻击。为了避免这种情况，需要将接口返回数据中的特殊字符进行处理。

const escapeHtml = (unsafe) => {
    return unsafe
        .replace(/&/g, '&amp;')
        .replace(/</g, '&lt;')
        .replace(/>/g, '&gt;')
        .replace(/"/g, '&quot;')
        .replace(/'/g, '&#039;');
}

const data = JSON.parse(responseData);
document.getElementById('content').innerHTML = escapeHtml(data.content);

在上例中，我们定义了一个 escapeHtml 函数，用于将接口返回数据中的特殊字符进行转义处理。这样，即使接口返回的内容中存在恶意脚本，也可以有效地避免 XSS 攻击。

总结

以上是一些常见的前端接口校验方式。虽然每个项目的接口规范不尽相同，但总体来说，校验接口返回数据的类型、结构、内容和错误码，以及防止恶意脚本注入等操作，都是前端开发者必须掌握的技能。

到此这篇关于常见JS前端接口校验方式总结的文章就介绍到这了,更多相关JS前端接口校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

w3c声明下可运行兼容性比较好的js对联广告集合
最近有美工朋友找我们要兼容性比较好的对联广告代码，我们给他一个他竟然不能运行，经过排查，这是因为现在的广告也用了一样代码，函数命名重复。
2011-07-07
超级详细的webpack Plugin讲解
plugin是插件的意思,通常是用于对某个现有的架构进行扩展,下面这篇文章主要给大家介绍了关于webpack Plugin的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
2022-04-04
javascript 闭包详解
这篇文章主要详细介绍了javascript 闭包的相关资料，十分详尽,需要的朋友可以参考下
2015-02-02
JavaScript axios安装与封装案例详解
这篇文章主要介绍了JavaScript axios安装与封装案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-08-08
js利用iframe实现选项卡效果
这篇文章主要为大家详细介绍了js利用iframe实现选项卡效果，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-08-08
JS上传图片前的限制包括(jpg jpg gif及大小高宽)等
文件上传之前的检测，通常是通过文件名来判断文件类型是否合法，但是要想检测文件的大小很难办到，除非在本地或者使用控件。使用JS可以轻松解决词问题，js在上传图片前判断大小这个可以用javascript实现,效果
2012-12-12
正则表达式校验身份证号码完整代码示例
在做用户实名验证时,常会用到身份证号码的正则表达式及校验方案,下面这篇文章主要给大家介绍了关于正则表达式校验身份证号码的相关资料,需要的朋友可以参考下
2024-04-04
JS前端开发之exec()和match()的对比使用
match()方法可在字符串内检索指定的值,或找到一个或多个正则表达式的匹配,下面这篇文章主要给大家介绍了关于JS前端开发之exec()和match()的对比使用的相关资料,需要的朋友可以参考下
2022-09-09
ionic 3.0+ 项目搭建运行环境的教程
本篇文章主要介绍了ionic 3.0+ 项目搭建运行的教程，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-08-08
深入浅出es6模板字符串
这篇文章主要介绍了深入浅出es6模板字符串,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-08-08