PHP_DOC 实时生成 API 文档

bigdevil_s 发布于2019-07-01 12:21 / 418人阅读

摘要：随着的迅速发展，如何编写出更加规范的文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档呢那么你就啦工欲善其事，必先利其器。可在线实时查看接口的参数返回和说明，无须手动维护文档。实现列出所有的文件。

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

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

那么你就OUT啦！

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

本文分享一款工具：PHP_DOC。

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

背景

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

维护客户端接口。

维护 Rpc 接口。

...

那么问题来了，

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

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

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

原理

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

实现

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

效果图

图1

图2

图3

图4

PHP_DOC 实时生成 API 文档 GIF

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

Thanks ~

推荐阅读

系统的讲解 - SSO 单点登录

系统的讲解 - PHP WEB 安全防御

系统的讲解 - PHP 缓存技术

系统的讲解 - PHP 接口签名验证

系统的讲解 - PHP 浮点数高精度运算

混合云超融合服务器生成API文档文档生成 python生成文档 python文档生成

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/30546.html

开源的api文档管理系统

摘要：国外的话国内的国内开源的非常好用的一款文档管理系统，安装也非常方便，只需将源代码放到项目目录下自动安装运行即可，不要要注意版本必须大于界面简洁功能强大的阿里的接口管理工具，开源免费，接口自动化，数据自动生成，自动化测试，企业级管理。在项目中，需要协同开发，所以会写许多API文档给其他同事，以前都是写一个简单的TXT文本或Word文档，口口相传，这种方式比较老土了，所以，需要有个api...

zsirfs 2019-06-27 14:58 评论0 收藏0
JavaScript开发工具大全

摘要：发布于之后，采用了完全不同的方式，使用函数定义任务。它允许开发者使用它们的补丁和更新来修复这些安全漏洞。提供了工具用于扫描依赖来监测漏洞。是一个开源诊断工具，用于和应用。是和开发的一款新的包管理工具。与相比，它解决了安全性能以及一致性问题。译者按: 最全的JavaScript开发工具列表，总有一款适合你！原文: THE ULTIMATE LIST OF JAVASCRIPT TOO...

nifhlheimr 2019-08-20 17:34 评论0 收藏0
ApiPost与PostMan，你可以任选一款不错的接口管理工具

摘要：同时还有对应的返回值字段描述通过这个方法，可以随时随地的测试以及更新文档，简直是后端小伙伴的福音但是，不知道小伙伴们有没有发现一个问题，就是在生成接口文档的时候，还是需要自己填写参数描述。对于测试同学来说，这是一个非常不错的功能。我们都知道在一个团队中是由很多角色组成的，例如：业务、产品、...

crossoverJie 2021-09-29 09:34 评论0 收藏0
【效率专精系列】善用API统一描述语言提升RestAPI开发效率

摘要：其标准为前身是，提供强大的在线编辑功能，包括语法高亮错误提示自动完成实时预览，并且支持用户以格式撰写导入导出转换文档。团队内部RestAPI开发采用设计驱动开发的模式，即使用API设计文档解耦前端和后端的开发过程，双方只在联调与测试时耦合。在实际开发和与前端合作的过程中，受限于众多因素的影响，开发效率还有进一步提高的空间。本文的目的是优化工具链支持，减少一部分重复和枯燥的劳动。现状...

tianyu 2019-08-16 10:42 评论0 收藏0
5分钟快速集成UCloud实时音视频服务URTC-Linux Ubuntu端

摘要：通过集成，可以从零开始，快速搭建出实时音视频通信平台，可以应用于语音和视频社交在线教育和培训远程医疗在线会议直播等多种业务场景。使用服务之前，首先需要注册账号并且完成实名认证。确定后，自动生成。推流成功后，即可直播观看视频。通过集成URTC SDK，可以从零开始，快速搭建出实时音视频通信平台，可以应用于语音和视频社交、在线教育和培训、远程医疗、在线会议、直播等多种业务场景。集成URTC S...

Tecode 2022-06-28 18:59 评论0 收藏0