got 请求库 API 使用说明

git仓库地址：https://github.com/sindresorhus/got

Node 常用的请求库 request 作者已经不更新了(过时了），现在比较流行的是 got，当然作为一个更好的替代它肯定有自己的优势。直接上https://www.npmjs.com/package/got 上的对比图：

got(url: string | URL, options?:OptionsInit, defaults?:Options)

Url 可以直接作为第一个参数，或者包含在第二个options选项参数里(url: '地址')；
第二个参数options文档地址：https://github.com/sindresorhus/got/blob/HEAD/documentation/2-options.md

options 对象内的参数：

我们来列举说明几个常用的：

- url：Type: string | URL

请求地址，没啥好说的

- searchParams：Type: string | URLSearchParams | object

查询参数，就是请求地址后面那串

import got from 'got';

const response = await got('https://httpbin.org/anything', {
    searchParams: {
        hello: 'world',
        foo: 123
    }
}).json();

console.log(response.args); // => {hello: 'world', foo: 123}

如果需要传递数组，可以用URLSearchParams转化：

const searchParams = new URLSearchParams([['key', 'a'], ['key', 'b']]);

await got('https://httpbin.org/anything', {searchParams});

- method：Type: string

请求方式，默认: GET，可选值：<'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE'>
还可以不传在选项里，直接got.(...)这样操作：

const { data } = await got.post('https://httpbin.org/anything', {
  json: { hello: 'world'}
}).json();

console.log(data); // => {"hello": "world"}

- headers：Type: object

要发送的 HTTP headers对象，里面可以传一些需要的请求头参数，比如 “cookie”、"content-type"、"Origin"等；

注意⚠️：其实"content-type"没必要传，got 会根据我们传的请求体格式自动配置（下面的json、body参数会详细说明）有时传了反而会报错。

- responseType：Type: 'text' | 'json' | 'buffer'

解析响应内容的方式，默认: 'text'
got 还有另一种等价的处理方式，直接在 got promise 后加上.text()、.json() 或 .buffer()等方法，这就像将选项设置为 {responseType: 'json', resolveBodyOnly: true}，它们会为解析后的主体返回另一个 promise。

- followRedirect：Type: boolean

是否遵循重定向响应，默认 true

- timeout：Type: object

请求超时时间，详细API ：Timeout API

- json：Type: JSON-serializable values

JSON body，如果配置了, 请求头的 content-type 会被默认设置为 application/json

普通表单提交(无文件上传)之类的 post 我们用这个传请求体(payload)即可。

const { data } = await got.post('https://httpbin.org/anything', {
  json: { hello: 'world' }
}).json();

- body：Type: string | Buffer | stream.Readable | Generator | AsyncGenerator | FormData 或 form-data 实例

要发送的 payload，如果有文件上传的需求，我们就会用 body。

如果 body 是 string 和 Buffer 类型，如果请求头缺少 content-length 和 transfer-encoding 标头，则会自动设置 content-length。
当 body 是 fs.createReadStream()的实例时，不会自动设置 content-length 标头。

如果请求体是FormData：

import { FormData } from 'formdata-node'; // or:
// import { FormData } from 'formdata-polyfill/esm.min.js';

const form = new FormData();
form.set('greeting', 'Hello, world!');
form.append('myfile', fs.createReadStream('/foo/bar.jpg'));

const data = await got.post('https://httpbin.org/post', {
  body: form
}).json();

console.log(data.form.greeting);
//=> 'Hello, world!'

- form：Type: object

使用new URLSearchParams(form)).toString()将 form body 转换为query string 的格式。
如果设置了，则请求头的 content-type 会默认为application/x-www-form-urlencoded。

最后上个具体例子(post)：

发送验证码的路由接口，部分次要代码不全，只是看个实现过程，具体可以去我的 GitHub：https://github.com/aizawasayo/animal_server （nodejs + koa2 服务端项目）

import got from 'got'
import { Base64 } from 'js-base64'

const sendMsg = async (ctx, next) => {
  // 随机生成 6位 验证码
  const code = randomCode(6)
  // 请求体内容
  let body = {
    to: phone,
    appId: AppID,
    templateId: '1', // 测试模板id是1
    datas: [code, '1'],
  }
  const headers = {
    Accept: 'application/json',  
    Authorization: Base64.encode(ACCOUNT_SID + ':' + time)
  }
  try {
    const response = await got
      .post(url, {
        headers: headers,
        json: body,
      })
      .json()

    console.log('statusCode:', response.statusCode)
    console.log('body:', response.body)
    if (response.statusCode === '000000') {
      ctx.body = {
        code: 200,
        message: '发送成功！',
      }
    } else {
      ctx.body = { code: 500, message: body.statusMsg }
      // throw new errs.HttpException(body.statusMsg)
    }
  } catch (error) {
    console.log('error:', error)
    // 自己定义的特定类型错误抛出方法，可以无视
    throw new errs.ParameterException(error.message)
}

export default sendMsg

使用：

const Router = require('@koa/router')
import sendMessage from '@/routes/admin/sendMessage'

const adminRouter = new Router({ prefix: '/admin' })
// 短信验证码
adminRouter.post('/message', sendMessage)

got 还有几个好用的钩子，beforeRequest、afterResponse、beforeError等，我暂时没用到就不展开了，用过 axios 一般都能掌握，文档地址是：https://github.com/sindresorhus/got/blob/main/documentation/9-hooks.md