apidocfor php,基于php开发的RESTful ApiDoc文档

apiDoc基于rest的web API文档生成器，可以根据代码注释生成web api文档，自动生成静态的html网页文档，不仅支持项目版本号，还支持API版本号。

使用apiDoc不需要自己麻烦的调word的格式，就可以生成一份漂亮的API文档。既美观又可以装逼。。。先看效果

1、安装：

php运行环境：php(5.5.12) +  apiDoc 。apiDoc的安装我们可以通过 npm 命令来安装。apiDoc基于NodeJS实现，所以你需先有NodeJS及NPM环境 　　windows安装node如下，直接下一步即可：

通过在命令行模式下，node -v即可查看当前node的版本、npm -v 即可查看当前 node 集成的 npm 的版本。

2、新建一个apiDoc的目录，并进入当前目录。运行 npm install apidoc 即可完成 apidoc模块的安装。

此时所有准备工作已经完成，就可以进入编写apidoc文档的工作了。

3、通过编写apidoc.json 和 test.php文件，然后在命令行下，执行命令  apidoc test.php  即可生成一个doc目录。

注意：通过此命令 apidoc test.php 生成的文档会包含默认的模板内容，修改　　api_data.json、api_data.js文件，删除多余内容即可。

更多内容请参考官方文档：

基于 React 开发了一个 Markdown 文档站点生成工具

Create React Doc 是一个使用 React 的 markdown 文档站点生成工具.就像 create-react-app 一样,开发者可以使用 Create React Doc 来开发 ...

【转载】Java Restful API 文档生成工具 smart-doc

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景 没有背景.就自己做自己 ...

Spring Boot 集成 Swagger 生成 RESTful API 文档

原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档 简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...

Swagger+Spring mvc生成Restful接口文档

简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

Spring Boot中使用Swagger2构建强大的RESTful API文档

由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这 ...

Spring Boot学习笔记 - 整合Swagger2自动生成RESTful API文档

1.添加Swagger2依赖 在pom.xml中加入Swagger2的依赖 io.spr ...

使用Swagger2构建强大的RESTful API文档(1)(二十二)

由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这 ...

Spring Boot中使用Swagger2构建RESTful API文档

在开发rest api的时候,为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTful API文档来记录所有接口细节,然而这样的做法有以下几个问题: 1．由于接口众多,并且细 ...

Apache PDFbox开发指南之PDF文档读取

转载请注明来源:http://blog.csdn.net/loongshawn/article/details/51542309 相关文章:

随机推荐

卸载自己编译的程序(ubuntu14.04)

cd 源代码目录make clean./configuremake uninstall

[问题2014A13] 解答

[问题2014A13]  解答 先引入两个简单的结论. 结论 1  设 \(\varphi\) 是 \(n\) 维线性空间 \(V\) 上的线性变换, 若存在正整数 \(k\), 使得 \(\math ...

浅析C#中的“==”和Equals

1.“==”和Equals两个真的有关联吗? 对于“==”和Equals大多数网友都是这样总结的: “==” 是比较两个变量的值相等. Equals是比较两个变量是否指向同一个对象. 如:这篇文章,并 ...

【C语言】05-printf和scanf函数

一.printf函数 这是在stdio.h中声明的一个函数,因此使用前必须加入#include ,使用它可以向标准输出设备(比如屏幕)输出数据 1.用法 1> pr ...

【PDF】java使用Itext生成pdf文档--详解

[API接口]  一.Itext简介 API地址:javadoc/index.html:如 D:/MyJAR/原JAR包/PDF/itext-5.5.3/itextpdf-5.5.3-javadoc/ ...

Android Ant批量打包

一.配置Ant环境变量 JAVA_HOME=/software/jdk1.6.0_24 ANT_HOME=/software/apache-ant-1.9.2 Android_Home=/softwa ...

C++的类和对象

#include // 预处理命令 using namespace std; class Student{ // 声明一个类,类名为Student private : ...

进程管理之wait和waitpid

僵尸进程 在介绍wait.waitpid和waitid函数之前,首先要介绍一下僵尸进程,因为,这三个函数的本质任务就是处理僵尸进程的问题. 进程会我们的生命体一样,也有消亡.进程在退出时,内核会清理进 ...

J - Network of Schools

来源poj1236 A number of schools are connected to a computer network. Agreements have been developed am ...

SCCM2012 R2实战系列之五：发现方法

打开SCCM2012的控制台 点击左侧栏的“管理”选项,然后展开“层次结构配置”,点击“发现方法”来配置客户端发现. 勾选“启用Active Directory林发现”.“发现Active Direc ...