什么是 @octokit/request？
@octokit/request 是 GitHub 官方维护的 npm 包，可以方便地通过 Node.js 向 GitHub API 发送请求。这个包提供了一个简单的接口，使用这个包，开发者可以快速地对 GitHub 进行操作。
安装和使用
安装 @octokit/request，需要在终端中执行以下命令：
npm install @octokit/request
安装好后，可以在代码中引入 @octokit/request：
const { request } = require('@octokit/request');发送请求
@octokit/request 提供了方便的接口可以帮助我们发送请求，其中包括 request()，get(),put()，post() 和 delete()。我们可以根据需要选择相应的接口来发送请求。
sendRequest(options)
sendRequest(options) 是最基本的发送请求的方法，可以通过传递一个 JSON 对象来发送请求。该方法通过 Promise 来传递结果，这个 Promise 的返回值是请求返回的数据。
-- -------------------- ---- ------- ----- - ------- - - ---------------------------- ------------ ------------------ - --------- --------- -------------- -- - -------------------- -------------- -- - ------------------- ---
get(url, options?)
get(url, options?) 用来发送一个 GET 请求，并且根据需要可以传递 URL 和参数。这个方法返回一个 Promise，Promise 的返回值是请求的结果。
const { get } = require('@octokit/request');
get('/users/octokit').then(result => {
console.log(result);
}).catch(error => {
console.log(error);
});put(url, options?)
put(url, options?) 用来发送一个 PUT 请求，并且根据需要可以传递 URL 和参数。这个方法返回一个 Promise，Promise 的返回值是请求的结果。
-- -------------------- ---- ------- ----- - --- - - ---------------------------- ------------------ - ----- ------------ -------------- -- - -------------------- -------------- -- - ------------------- ---
post(url, options?)
post(url, options?) 用来发送一个 POST 请求，并且根据需要可以传递 URL 和参数。这个方法返回一个 Promise，Promise 的返回值是请求的结果。
const { post } = require('@octokit/request');
post('/users/octokit/follow', { headers: { accept: 'application/vnd.github.v3+json' } })
.then(result => {
console.log(result);
}).catch(error => {
console.log(error);
});delete(url, options?)
delete(url, options?) 用来发送一个 DELETE 请求，并且根据需要可以传递 URL 和参数。这个方法返回一个 Promise，Promise 的返回值是请求的结果。
const { del } = require('@octokit/request');
del('/user/repos/octokit/test-repo').then(result => {
console.log(result);
}).catch(error => {
console.log(error);
});参数说明
在发送请求时，还可以传递其他参数，这些参数包括 baseUrl，headers，mediaType 和 request.mediaType 等，并且在发送请求时，可以通过 options 对象来传递这些参数。
baseUrl
如果需要修改请求的 base URL，可以配置 baseUrl 参数。
const { get } = require('@octokit/request').defaults({
baseUrl: 'https://github.enterprise.com/api/v3',
});
get('/repos/octokit/rest.js');headers
如果需要修改请求的 header，可以配置 headers 参数
const { get } = require('@octokit/request').defaults({
headers: {
'user-agent': 'myApp/1.0.0'
}
});
get('/users/mojombo/orgs');mediaType
可以配置 mediaType 参数，指定要返回的媒体类型。
const { get } = require('@octokit/request').defaults({
mediaType: { format: 'previews', previews: ['squirrel-girl'] }
});
get('/repos/octokit/rest.js');request.mediaType
可以配置 request.mediaType 参数，指定发送请求的媒体类型。
const { request } = require('@octokit/request').defaults({
request: {
mediaType: { format: 'previews', previews: ['squirrel-girl'] }
}
});
request('GET /repos/octokit/rest.js');总结
以上就是 npm 包 @octokit/request 的使用介绍，这个包很方便，可以帮助我们使用 Node.js 对 GitHub API 进行操作。在使用时，我们需要了解发送请求的基本方法和参数，这样就可以使用这个包来方便地进行操作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/96077