apidoc 生成文档空白怎么生成

来源：蜘蛛抓取(WebSpider) 时间：2017-09-25 05:02 标签： apidoc生成代码
yii的api文档是用什么软件从代码的注释部分自动生成的吗？ - 问答 - Yii Framework 中文社区
yii的api文档是用什么软件从代码的注释部分自动生成的吗？
2596次浏览
悬赏 10 金钱
yii的api文档是用什么软件从代码的注释部分自动生成的吗？
yii2生成文档用的是这个扩展
共 3 条回复谢谢舰长~
求问，Yii2.0权威指南 文档是用什么写的？
你知道怎么生成中文的文档 类似这个问题
您需要登录后才可以回答。 |php apidoc生成接口文档示例
作者：用户
本文讲的是php apidoc生成接口文档示例，
api 生成接口文档示例：
&name&: &9月份赠险领取分享活动微信接口&,
&version&: &1.0.0&,
&description&: &9月份赠险领取分享活动微信接口文档 (t=1) &,
api 生成接口示例：
"name": "9月份赠险领取分享活动微信接口",
"version": "1.0.0",
"description": "9月份赠险领取分享活动微信接口文档 (t=1) ",
"sampleUrl" : "/"
另存文件名为：apidoc.json
apidoc -i 要生成文档的项目目录 -o 接口文件的生成目录
接口代码文件代码如下：
* @api {post} /news/lists 新闻信息
* @apiVersion 1.0.0
* @apiName lists
* @apiGroup User
* @apiPermission 登录用户
* @apiDescription 用户登录后进入该页面，将显示新闻信息列表
* @apiSampleRequest /v1/news/lists
* @apiSuccess (返回值) {string} id 主键ID
* @apiSuccess (返回值) {string} name 客户姓名
* @apiSuccess (返回值) {string} user_head_img 客户头像
* @apiSuccess (返回值) {integer} sex 性别:0-未设置,1-男,2-女
* @apiSuccess (返回值) {string} demand 客户需求
* @apiSuccessExample {json} 成功示例:
* {"code": 1,"msg": "","data": {"id": "57b3cdb46b787","name": "余浩苗","user_head_img": "userHead//6.jpg","sex": "1","demand": "本人想买保险，请速联系！"}}
* @apiErrorExample (json) 错误示例:
{"code":-1,"msg":"密码错误","data":{}}
///////////////////////////////////////
* @api {post} /news/rob 抢客户
* @apiVersion 1.0.0
* @apiName rob
* @apiGroup User
* @apiPermission 登录用户
* @apiDescription 抢客户
* @apiParam {string} id 主键ID
* @apiSampleRequest /v1/news/rob
* @apiSuccessExample {json} 成功示例:
* {"code":1,"msg":"","data":{}}
* @apiErrorExample (json) 错误示例:
{"code":-1,"msg":"错误信息","data":{}}
///////////////////////////////////////
更多关于apidoc的用法请参考：/
以上是云栖社区小编为您精心准备的的内容，在云栖社区的博客、问答、公众号、人物、课程等栏目也有的相关内容，欢迎继续使用右上角搜索按钮进行搜索文档
百度翻译api接口示例、api接口示例、javadoc生成api文档、yii 生成文档 apidoc、apidoc 生成文档，以便于您获取更多的相关知识。
稳定可靠、可弹性伸缩的在线数据库服务，全球最受欢迎的开源数据库之一
6款热门基础云产品6个月免费体验；2款产品1年体验;1款产品2年体验
弹性可伸缩的计算服务，助您降低 IT 成本，提升运维效率
开发者常用软件，超百款实用软件一站式提供
云栖社区()为您免费提供相关信息，包括
，所有相关内容均不代表云栖社区的意见！使用apidoc生成实用炫酷吊炸天的api文档 - 简书
使用apidoc生成实用炫酷吊炸天的api文档
为什么要用apidoc
apidoc根据其自定义注释语法自动生成api文档，我们只需要把代码中的注释按照其语法来写就能生成需要的文档，不需要手动写markdown。
apidoc生成的文档相比markdown，漂亮直观又实用。
如果API需要修改或者更新，直接修改代码的注释中即可。apidoc核心思路，文档与代码合一，修改代码就是修改文档，方便又实用。
可以配合grunt使用，使自动化生成文档更加智能，支持多种语言。
0x01 安装和配置apidoc
首先要确认你的系统安装了nodejs，然后执行npm install -g apidoc即可。
配置apidoc，在你的项目下创建apidoc.json文件，{
"name": "测试APIs",
"version": "1.0.0",
"description": "接口测试",
"title": "test APIs",
"url" : "http://localhost:9220/sapi/v1/production_plan",
"sampleUrl" : "http://localhost:9220/sapi/v1/production_plan"
0x02 如何使用
apidoc是根据其自定义注释语法来生成文档的，语法可参考下面是作者的一些注释代码，可以参考这个把注释写到你的代码相应的位置：
* @api {get} /test 接口测试
* @apiDescription 根据ID（id）获取列表信息
* @apiGroup test APIs
* @apiParam {Number} id 任务ID
* @apiParam {Number} [page] 页数
* @apiParam {Number} [perpage] 每页的条数
* @apiParamExample {string} 请求参数格式:
?id=123&page=1&perpage=20
* @apiVersion 1.0.0
* @apiErrorExample {json} 错误返回值:
"code": 10003,
"msg": "ParametersError [Method]:get_tests参数错误!",
"error": {
"page": "",
"perpage": ""
"status": "fail"
* @apiSuccessExample {json} 正确返回值:
"code": 0,
"msg": "OK ",
"id": "471233",
"testCode": "000050",
"status": "ok",
"count": "14"
@api 定义API的请求方法、路径和名字
@apiDescription 定义API的描述
@apiGroup 定义API的分组
@apiParam 定义API的参数
@apiParamExample 参数请求的事例
@apiVersion 版本
@apiErrorExample API错误示例
@apiSuccessExample API正常示例
0x03 生成文档
执行命令apidoc -i src/ -o apidoc/
-i src/是把src文件夹下带有apidoc语法注释的代码全部生成文档
-o apidoc/是文档的生成目录一切大功告成，打开apidoc文件夹下的index.html文件
简书作者 小菜荔枝 转载请联系作者获得授权
美式=咖啡+水，卡布奇诺=咖啡+奶泡
拿铁=咖啡+牛奶，摩卡=咖啡+可可巧克力
嗯，喝美式要加冰。
谢谢，会记一辈子！如何生成rest api文档？ - 知乎114被浏览16346分享邀请回答11添加评论分享收藏感谢收起02 条评论分享收藏感谢收起查看更多回答

我要回帖

更多关于 apidoc生成代码 的文章

 

随机推荐