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

使用ApiDoc

时间:2023-03-30 06:14:32 PHP

表示apiDoc从源代码中的API注释创建文档。ApiDoc是一个接口文档,它的创建方法是根据你源码的接口注释。我们只需要为接口编写相应的文档,然后使用apiDoc工具生成接口文档即可生成文档,方便管理和查看。配置方法1.安装apidoc(什么是npm???自己问前端同学。。)npminstallapidoc-ginstallhttp-servernpminstallhttp-server-g2.在界面中添加文档(官方示例),添加在Controller入口方法的前面。/***@api{get}/user/:id请求用户信息*@apiNameGetUser*@apiGroupUser**@apiParam{Number}id用户唯一ID。**@apiSuccess{String}firstname用户的名字。*@apiSuccess{String}lastname用户的姓氏。*/3。创建apidoc.json(官方示例){"name":"example","version":"0.1.0","description":"apiDocbasicexample","apidoc":{"title":"自定义apiDoc浏览器title","url":"https://api.github.com/v1"}}4.生成apiDocapidoc-iapp/Http/Controllers-oapidoc/5。运行http-serverapi/doc补充说明参考http://apidocjs.com/

最新推荐
猜你喜欢