@apacejs/response

handle response data structure

Usage no npm install needed!

<script type="module">
  import apacejsResponse from 'https://cdn.skypack.dev/@apacejs/response';
</script>

README

@APACEJS/RESPONSE

介绍

restful 接口返回数据结构：

{
    code: '0000',   // 值为'0000'表示请求成功，值为非'0000'，通常为'9999'，表示业务逻辑失败，如用户名已存在，余额不足等
    message: '',    // 值为非'0000'，通常为'9999'，服务端返回给客户端的文案
    data: {},       // 服务端返回给客户端的数据，json 格式
}

使用

在 Typescript 中写法

import ApaceResponse from '@apacejs/response'

app.get('/users', (req, res) => {
    res.json(ApaceResponse.success([], '查询列表成功'))
    // 相当于如下写法
    // res.json({ code: '0000', message: '查询列表成功', data: [] })
})

在 Nodejs 中写法

const ApaceResponse = require('@apacejs/response').default

app.get('/users', (req, res) => {
    res.json(ApaceResponse.failure('查询列表失败'))
    // 相当于如下写法
    // res.json({ code: '9999', message: '查询列表失败', data: null })
})

API

const ApaceResponse = require('../lib/index').default

console.log(ApaceResponse.success())
console.log(ApaceResponse.success('新增操作成功'))
console.log(ApaceResponse.success({ name: 'dkvirus' }, '查询成功'))
console.log(ApaceResponse.failure('操作失败'))

// { code: '0000', message: '操作成功', data: null }
// { code: '0000', message: '新增操作成功', data: null }
// { code: '0000', message: '查询成功', data: { name: 'dkvirus' } }
// { code: '9999', message: '操作失败', data: null }