博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
PHP_DOC 实时生成 API 文档
阅读量:6716 次
发布时间:2019-06-25

本文共 454 字,大约阅读时间需要 1 分钟。

随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。

你是否还通过手写的方式来生成和编写这些文档呢?

那么你就OUT啦!

工欲善其事,必先利其器。

本文分享一款工具:PHP_DOC

可在线实时查看API接口的参数、返回和说明,无须手动维护文档。

背景

你还在为维护 API文档 而烦恼吗?

维护 客户端 接口。

维护 Rpc 接口。

...

那么问题来了,

能不能根据代码进行生成API文档呢?

能不能生成高逼格的界面来进行展示呢?

能不能适合不同框架的系统呢?

原理

首先用程序分析代码的注释,然后进行友好的展示。

实现

(1) 列出所有的API文件。

(2) 点击文件名,可以查看里面的接口。
(3) 点击接口名称,可以查看接口的注释。

效果图

图1

图2

图3

图4

PHP_DOC 实时生成 API 文档 GIF

如果大家需要下载源码,可以关注微信公众号,回复 “php_doc” 即可。

Thanks ~


作者:PHP后端开发者

免费提供技术咨询服务(自己懂的知识)。

QQ群:564557094。

关注微信公众号,留言即可,看到留言后会及时回复。

IT小圈儿

转载地址:http://cmelo.baihongyu.com/

你可能感兴趣的文章
HttpServletRequest接口实例化的使用
查看>>
iOS 网易新闻用到的框架
查看>>
301重定向方法大全及SEO中网址规范化,看着不错先收下
查看>>
Windows Live Writer 在线安装失败的解决方法。
查看>>
基于Geoserver发布时间地图
查看>>
使用DOSBox在Win7_x64下搭建汇编环境
查看>>
js插件大全 jquery插件大全
查看>>
解决ubuntu 14.04删ibus导致系统设置项目的损失后,,退出关机问题是不正常的
查看>>
理解vmp
查看>>
CentOS6.4下Mysql数据库的安装与配置
查看>>
[转]GC简介
查看>>
poj 1466 Girls and Boys (最大独立集)
查看>>
辛星与您使用CSS导航条
查看>>
统计一个文件中出现字符'a'的次数
查看>>
将Eclipse包括第一3正方形jar包裹Project Export并产生能够执行jar
查看>>
Google Pagespeed,自动压缩优化JS/CSS/Image
查看>>
Gentoo源码安装图解
查看>>
【转载】COM 组件设计与应用(三)——数据类型
查看>>
Python yield与实现
查看>>
购物车特效收集
查看>>