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

浮岩

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

除了API密钥外该站点是完全静态的,我想在代码示例中包括该代码,具体取决于用户(如果用户登录,则将获得自己的API密钥)。

我如何在维持静态站点的同时实现这一目标(我使用的是静态站点生成器middleman)。

阿列克谢·马蒂什金(Alexei Matiushkin)

我建议您在所有页面上都包含小型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] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

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

来自分类Dev

带有邮戳API的嵌入式图像附件

来自分类Dev

在ODM上还原带有嵌入式文档的文档

来自分类Dev

带有表单域的PDF文档的嵌入式签名

来自分类Dev

带有AngularJS的XSRF:DocuSign API嵌入式视图客户端实现

来自分类Dev

获取所有嵌入式文档

来自分类Dev

带有负数的嵌入式除法

来自分类Dev

带有嵌入式码头的招摇

来自分类Dev

TIKA将带有嵌入式图像的Word文档转换为HTML

来自分类Dev

Mongo Shell,如何查找/汇总带有列表的嵌入式文档

来自分类Dev

MongoDB - 带有嵌入式文档的自定义排序聚合

来自分类Dev

FSharp嵌入式API添加变量

来自分类Dev

iOS 7嵌入式日历API

来自分类Dev

DocuSign API嵌入式签名iFrame

来自分类Dev

如何使用文档api在OrientDB中存储嵌入式地图?

来自分类Dev

Mongoid嵌入式文档属于_嵌入式文档

来自分类Dev

没有数组的嵌入式文档?

来自分类Dev

Mongo + Ruby Rails:获取所有嵌入式文档

来自分类Dev

查询具有大小的Mongo嵌入式文档

来自分类Dev

带有多个嵌入式图标的EXE

来自分类Dev

发送带有嵌入式图像的电子邮件

来自分类Dev

Hibernate抛出带有嵌入式ElementCollection的ConcurrentModificationException

来自分类Dev

带有Java EE 7 WebSocket的嵌入式tomcat

来自分类Dev

带有插件的Cordova 3.5嵌入式Webview

来自分类Dev

带有嵌入式MonthCalendar问题的UserControl

来自分类Dev

Restangular:带有包含嵌入式数组的对象的getList

来自分类Dev

Perl解析带有嵌入式逗号的CSV文件

来自分类Dev

带有嵌入式功能的Python内存爆炸

来自分类Dev

带有嵌入式数据透视表的多对多