草庐IT

got 请求库 API 使用说明

AizawaSayo 2023-03-28 原文

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

有关got 请求库 API 使用说明的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库,所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐