我正在为一个项目设置API文档,并想知道最适合该工作的工具是什么。
除了API密钥外,该站点是完全静态的,我想在代码示例中包括该代码,具体取决于用户(如果用户登录,则将获得自己的API密钥)。
我如何在维持静态站点的同时实现这一目标(我使用的是静态站点生成器middleman)。
我建议您在所有页面上都包含小型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 );
}
});
希望能帮助到你。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句