带有嵌入式API密钥的静态API文档

Question

我正在为一个项目设置API文档，想知道什么是最适合这个工作的工具

该网站是完全静态的除了API密钥，我想根据用户的不同将其包含在代码示例中（如果用户登录，则用户将获得自己的API密钥）。

如何在维护静态站点的同时实现这一点（我使用的是静态站点生成器，中间人）。

Answer 1

我建议您在所有页面上都包含小的ajax脚本，它将在页面中执行搜索和替换。

在静态页面上，你会有这样的代码：

<!-- EMPTY SPAN IN PAGE TEMPLATE -->
<span class='api-key'></span>

在任何需要嵌入api密钥的地方。脚本将执行简单的搜索和替换任务（假设页面上有jQuery，伪代码如下）：

$(document).ready(function () { 
  $.get( "/api/key", function( data ) { /* supply credentials if needed */
    $('.api-key').html( data ); 
  }
});

希望能有所帮助。