当前位置: 首页 > 后端技术 > PHP

一个基于thinkphp5自动生成api文档的包

时间:2023-03-29 17:25:01 PHP

reflection_api_doc将是一个基于thinkphp5自动生成api文档的库。虽然目前是v1.0_beta版本,但这个库旨在为开发者提供思路。对于具体的优化,你也可以开发自己的库。Github地址composer(packagist.org)使用方法:在extra目录下创建名为documents.php的配置文件。配置文件内容如下:API接口文档等。','template'=>'apple',//苹果绿:apple葡萄紫:葡萄'class'=>['app\index\controller\Demo','app\index\controller\Product','app\索引\controller\Store',],];其中template为模板类型,暂时提供了苹果绿和葡萄紫两种模板风格,虽然这两套模板都极其丑陋。所以你也可以在使用过程中开发自己的模板。要点:class是将生成文档的类(带有命名空间)。示例:注释参数含义解释@titletitle文档生成的类方法title@desc描述格式如下,地址,请求方法,备注等@param接收参数格式如下,名称,类型,是否必填,默认值、描述等@return返回参数格式如下,名称、类型、是否必填、描述等具体实现方法:/***@title文章接口管理*/classArticleextendsController{/***@title获取文章列表*@desc{"0":"接口地址:http://open.opqnext.com/index.php?c=article&a=index","1":"请求method:GET","2":"接口备注:加密校验必须传入keys值"}*@param{"name":"page","type":"int","re??quired":true“默认”:“1”,“desc”:“页数”}*@param{“名称”:“键”,“类型”:“字符串”,“必需”:真,“默认”:“xxx","desc":"加密字符串,substr(md5(\"合约密钥\".$page),8,16)"}*@param{"name":"word","type":"string","required":false,"default":"null","desc":"searchkeywords"}*@param{"name":"cate","type":"int","re??quired":false,"default":0,"desc":"CategoryID,不传则所有类别"}*@param{"name":"size","type":"int","re??quired":false,"default":5,"desc":"每页显示的项目数,默认为5"}*@return{"name":"status","type":"int","re??quired":true,"desc":"返回码:1表示成功,0表示失败","level":1}*@return{"name":"message","type":"string","re??quired":true,"desc":"返回信息","level":1}*@return{"name":"data","type":"array","re??quired":true,"desc":"returndata","level":1}*@return{"name":"id","type":"string","re??quired":true,"desc":"文章ID(22位字符串)","level":2}*@return{"name":"title","type":"string","re??quired":true,"desc":"文章标题","level":2}*@return{"name":"thumb","type":"string","re??quired":true,"desc":"文章列表图","level":2}*@return{"name":"content","type":"text","re??quired":true,"desc":"articlecontent","level":2}*@return{"name":"cate","type":"int","re??quired":true,"desc":"文章分类","level":2}*@return{"name":"tags","type":"array","re??quired":true,"desc":"articlelabel","level":2}*@return{"name":"id","type":"string","required":true,"desc":"tagID","level":3}*@return{"name":"tag","type":"string","re??quired":true,"desc":"标签名称","level":3}*@return{"name":"count","type":"int","re??quired":true,"desc":"使用的标签数"“级别”:3}*@return{“名称”:“img”,“ttype":"array","re??quired":true,"desc":"文章组图","level":2}*/publicfunctionindex(){//...具体实现方法}预览看起来很普通苹果绿:葡萄紫长相一般:支持如果需要使用自动生成文档之类的,欢迎加QQ群:452209691一起讨论