专门为 TP5 集成了自动生成 restful api 文档

浏览:2244 发布日期:2018/12/31 分类:技术分享 关键字: resetfulApi swagger 自动 验证参数
专门为 TP5 集成了自动生成 RESETful Api 文档,及验证请求参数

swagger-php 是为php 语言生成 swagger 注释的一个库。https://github.com/zircote/swagger-php
tien/swagger 是专门为 tp5 生成 swagger 注释的一个库,是基于 swagger-php 及 swagger-ui 两个开源库。
若要在控制器中书写 swagger 注释,那么会非常影响代码的阅读,及控制器的整洁(对于我这种强迫症来说,接受不了)。那么就需要把相应的注释拎出来放在另外一个文件。不过书写相应的注释也是大量的重复劳动,且也需要阅读相应的 swagger-php 文档(虽然是那么一丢丢的学习量,但不符合拿来即用主义哈)。
那么我就干了这么一件小事,就是通过调用一个中间件,在调用某个接口后,会自动在某个目录生成该接口的 swagger 注释,你的注意力可以完全放在具体的业务逻辑代码上,而不需要再分心给 swagger 的注释编写。当然相应付出的代价就是需要在相应的验证类多写两个属性,具体的情况库中的说明文档。不过这也不算白写,你也可以利用到验证错误友好提示功能上。
废话不多说,下面是库的链接:https://github.com/tienZheng/swagger
这是我的第一个开源库,我也是小白一个,还请多多指教,谢谢阅读!!若能给你提供帮助,记得 star 哈,这是对我最大的鼓励。
最佳答案
评论( 相关
后面还有条评论,点击查看>>