NestJs中HttpService如何以对象形式传递URL查询参数

NestJS 内置的 HttpService 底层基于 Axios 封装，所有 Axios 标准配置项都可以直接通过请求方法的第二个参数传入，不需要额外引入依赖。你之前的写法错误在于未将params字段包裹在配置对象内，且sort对应的字符串类型参数未加引号。

基础修正版写法 #

const response = await this.httpService
  .get(`https://api.github.com/users/${username}/repos`, {
    params: {
      per_page: 5,
      sort: 'created:asc',
      client_id: process.env.GITHUB_ID,
      client_secret: process.env.GITHUB_SECRET
    }
  })
  .toPromise();

全局配置优化（可选） #

如果有跨请求通用的参数、基础域名等配置，可以在注册HttpModule时提前全局声明，减少重复代码：

// app.module.ts 中注册 HttpModule 时配置
import { HttpModule } from '@nestjs/axios';
import { Module } from '@nestjs/common';

@Module({
  imports: [
    HttpModule.register({
      baseURL: 'https://api.github.com',
      params: {
        client_id: process.env.GITHUB_ID,
        client_secret: process.env.GITHUB_SECRET
      }
    })
  ]
})
export class AppModule {}

配置后业务代码可以简化为：

const response = await this.httpService
  .get(`/users/${username}/repos`, {
    params: {
      per_page: 5,
      sort: 'created:asc'
    }
  })
  .toPromise();

高版本兼容写法 #

如果使用的是 Nest v8+ 配套 RxJS 7+ 的版本，toPromise() 已被官方标记废弃，推荐用firstValueFrom替代：

import { firstValueFrom } from 'rxjs';

const response = await firstValueFrom(
  this.httpService.get(`/users/${username}/repos`, {
    params: {
      per_page: 5,
      sort: 'created:asc'
    }
  })
);

内容的提问来源于stack exchange，提问作者Jędrzej Tymiec