如何用JS结合HATEOAS调用REST API链接？GitHub API使用疑问

你说的没错，GitHub API虽然遵循部分REST设计原则，但在HATEOAS的完整实现上存在局限——它的根端点确实会返回核心资源的链接，但搜索类的URI模板并没有通过HATEOAS的方式暴露给客户端，这就是你觉得矛盾的核心原因。

HATEOAS的理想状态是：服务器返回所有可执行操作的链接（包括带参数模板的链接），客户端只需要根据链接的关系标识（rel）调用，完全不用硬编码或手动修改URI结构。但GitHub API的搜索接口既没包含在根端点的返回结果里，也没有通过其他资源的关联链接提供，导致你不得不硬编码模板，这直接打破了客户端与服务器的松耦合。

更优雅的解决方案（替代手动replace） #

针对复杂模板的重复操作问题，有两种务实的处理方式：

1. 使用专业的URI模板解析库

这类库能处理所有RFC 6570标准的URI模板，不用手动逐个替换参数，比如uri-template：

// 先安装依赖：npm install uri-template
import UriTemplate from 'uri-template';

// 解析模板
const searchTemplate = UriTemplate.parse('https://api.github.com/search/users?q={query}{&page,per_page,sort,order}');
// 填充参数生成请求地址
const endpoint = searchTemplate.expand({
  query: encodeURIComponent('your-search-query'),
  page: 1,
  per_page: 30
});

fetch(endpoint).then(res => res.json());

2. 封装通用模板处理函数（无需第三方库）

如果不想引入依赖，可以自己写一个函数处理模板参数，避免重复代码：

function expandUriTemplate(template, params) {
  return template.replace(/\{([^}]+)\}/g, (match, key) => {
    // 处理可选参数组（比如{&page,per_page}）
    if (key.startsWith('&')) {
      const subKeys = key.slice(1).split(',');
      return subKeys
        .map(k => params[k] ? `&${k}=${encodeURIComponent(params[k])}` : '')
        .join('');
    }
    // 处理必填参数
    return encodeURIComponent(params[key]);
  });
}

// 使用示例
const template = 'https://api.github.com/search/users?q={query}{&page,per_page,sort,order}';
const endpoint = expandUriTemplate(template, {
  query: 'your-search-query',
  page: 2
});

fetch(endpoint).then(res => res.json());

补充说明 #

GitHub API的这种设计确实是个遗憾，目前没有办法完全遵循HATEOAS的理想模式调用搜索接口。如果想更贴近松耦合，可以关注GitHub是否会在未来API版本中，把搜索模板加入根端点的资源链接里。但现阶段，上述两种方式是最能减少代码冗余、提升健壮性的方案。

内容的提问来源于stack exchange，提问作者Serafim