ApiDoc

介绍

APIDOC是在HTML，PHP和JQUERY中制成的模板，可帮助使用PHP REST API文档。

安装

将下面的链接复制到您的命令行以下载最新版本。无需在计算机上安装Apidoc，只需克隆文件并将其解压缩到服务器文件夹即可。

$ git clone -b 2.0.0-stable --single-branch https://github.com/brennoDuarte/ApiDoc.git ApiDoc-v2.0.0-stable

确保在浏览器中启用JavaScript。您可以打开深色模式，但是一旦您重新加载页面，它就会关闭。

配置

JSON文件在“ JSON”文件夹中。

您可以编辑文件“ config.json”，如下：

• “ appname” ：您的项目名称，
• “版本” ：您的项目版本，
• “描述” ：您的API的简要说明，
• “语言” ：制作API的语言，
• “协议” ：您的API协议，HTTP或HTTPS，

要编辑默认路由，请更改“ router.json”文件。 URL会话细分为：

• “ pathName” ：终点的主要路由，
• “ ID” ：通过单击路由按钮显示的模态ID。请记住为每个端点编辑其他ID，否则不会显示ID，
• “ pathget/getID/post/put/delete” ：API的端点，
• “ descriptionget/post/put/delete” ：端点的简要说明，
• “链接” ：端点的链接。单击它将在新标签中打开。

要添加新路径，请将“路径名”复制到“ config.json”文件中，然后将其粘贴到其他路径下方。

如果您有多个路线（获取，发布，放置，删除），请使用自定义路线。您可以为此编辑CustomRouter.json文件：

• “ CustomRouter” ：从您的端点命名主要路由，
• “ type” ：获取，发布，放置，删除或其他，
• “路径” ：API的端点，
• “描述” ：您的终点的简要说明，
• “链接” ：端点的链接。单击它将在新标签中打开。

如果您的API没有某个请求，请将字段更改为null。例子：

 " post " : {
    " id " : null,
    " pathPost " : null,
    " descriptionPost " : null,
    " link " : null
},

完成，只需在任何浏览中打开apidoc.php文件即可。