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<string, Primitive>

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

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.<method>(...)这样操作:

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

console.log(data); // => {"hello": "world"}
- headers:Type: object<string, string>

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

注意⚠️:其实"content-type"没必要传,got 会根据我们传的请求体格式自动配置(👇下面的jsonbody参数会详细说明)有时传了反而会报错。

- 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 | FormDataform-data 实例

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

如果 body 是 stringBuffer 类型,如果请求头缺少 content-lengthtransfer-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<string, Primitive>

使用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 还有几个好用的钩子,beforeRequestafterResponsebeforeError等,我暂时没用到就不展开了,用过 axios 一般都能掌握,文档地址是:https://github.com/sindresorhus/got/blob/main/documentation/9-hooks.md

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容