jwt、restfulapi

1、jwt

1.1jwt的介绍

JWT也就是JSON Web Token（JWT），是目前最流行的跨域身份验证解决方案。
JWT的组成：一个JWT实际上就是一个字符串，它由三部分组成：头部(Header)、载荷(Payload)与签名(signature)。

1.2、jsonwebtoken

//安装
npm i -S jsonwebtoken
npm i -S express cors mongoose

加密

const router = require('express').Router()
const jwt = require('jsonwebtoken')
// 设置一个jwt加密和解密时需要的key值
const secretKey = 'afwefjwlefjlwjflewjjfew;jfwe;jfwe;jf;ejf;w'

// 登录成功后，让保持登录者的状态，以前方案使用session,但是现在我们前后端分离，使用jwt

// 接口登录操作
router.post('/login', (req, res) => {
  let {username, password} = req.body
  res.send({
    code: 0,
    msg: 'ok',
    data: {
      // 加密
      token: jwt.sign({
        id: 1,
        username,
        // token过期时间 一般设置时长为2小时，有一些公司1天 1周 1个月
        // exp: Date.now() + 7200 * 1000
      }, secretKey)
    }
  })
})

解密

router.get('/users', (req, res) => {
  const token = req.headers['token']
  res.send({
    code: 0,
    msg: 'ok',
    data: {
      id: 1,
      name: '张三',
      token: jwt.verify(token, secretKey)
    }
  })
})

2、restfulapi

2.1、规范

①、协议：API与用户的通信协议，总是使用http或https协议。
②、域名：应该尽量将API部署在专用域名之下，例：http://api.demo.com
③、版本：应该将API的版本号放入URL，方便和直观，例http://api.demo.com/v1
④、路径
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词。例：https://api.example.com/v1/users
⑤、HTTP动词
对于资源的具体操作类型，由HTTP动词表示

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT/patch（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
DELETE（DELETE）：从服务器删除资源。
例下面的方式来操作和获取数据
GET /zoos：列出所有动物园
GET /zoos/ID：获取某个指定动物园的信息
POST /zoos：新建一个动物园
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
DELETE /zoos/ID：删除某个动物园


//常用状态码
200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

//返回结果
GET /collection：返回资源对象的列表数组
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档