javascript - 带有嵌入式 API key 的静态 API 文档

Question

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

该站点是完全静态的API key 除外，我想根据用户将其包含在代码示例中(如果用户登录，他们将获得自己的 API key ) ).

我如何在维护静态站点的同时实现这一点(我正在使用静态站点生成器，middleman)。

Answer 1

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

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

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

任何您想嵌入 api key 的地方。该脚本将执行简单的搜索和替换任务(伪代码如下，假设页面上有 jQuery):

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

希望对您有所帮助。