PHP_DOC 实时生成 API 文档

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

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

那么你就OUT啦!

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

本文分享一款工具:PHP_DOC

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

背景

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

维护 客户端 接口。

维护 Rpc 接口。

...

那么问题来了,

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

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

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

原理

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

实现

(1) 列出所有的API文件。
(2) 点击文件名,可以查看里面的接口。
(3) 点击接口名称,可以查看接口的注释。

效果图

PHP_DOC 实时生成 API 文档.gif

Thanks ~

如果大家想下载源码,欢迎大家Q我(留言、私信均可) ~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档...
    茶艺瑶阅读 902评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,881评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,117评论 25 708
  • 之前的两篇文章已经提到过,如今我已经完成了“坚持晨跑365天”的自我挑战,学到了很多跑步的知识,领悟到了坚持的意义...
    望月尘阅读 3,832评论 11 26
  • 近了 近了 我摸到了阳光的暖意 听到了孩子的欢声 还有还有那街角流浪的猫 只是看不到春风里的风筝 是不够近吗 是不...
    希茶一梦阅读 336评论 0 4