php apidoc生成接口文档示例

api 生成接口文档示例:

{

  "name": "9月份赠险领取分享活动微信接口",

  "version": "1.0.0",

  "description": "9月份赠险领取分享活动微信接口文档 (t=1) ",

  "sampleUrl" : "http://www.phpernote.com/"

}

另存文件名为:apidoc.json

apidoc -i 要生成文档的项目目录 -o 接口文件的生成目录

接口代码文件代码如下:

<?php
/**
 * @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/2016-08-18/1034587522576.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的用法请参考:http://apidocjs.com/

时间: 2024-08-30 22:03:39

php apidoc生成接口文档示例的相关文章

请教.net生成word文档的方法!

问题描述 大家好,我现在做的项目是用户在提交各种比较复杂申请表,在页面上录入各项内容,然后需生成word文档,因为申请表的格式固定,我以前的做法是,一.首先在word中画好表格,在需插入内容的地方标上书签,做成模板放在服务器上,然后页面生成word时去调用这个模板,把对应的内容插入到书签中,再保存成一个新的word文档放在服务器上.这种方法的缺点是,由于内容很多,需要做很多书签,容易出错,而且由于有大文本,格式也不好控制.二.在页面上自己把表格设置好,设置成word一样的格式,然后用javasc

C#生成Word文档代码示例

  这篇文章主要介绍了C#生成Word文档代码示例,本文直接给出代码实例,需要的朋友可以参考下 ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

.Net魔法堂:提取注释生成API文档

一.前言   在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险.   对于.Net,我们可以直接将类.方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量.   下面我们使用.Net唯一的注释生成API文档工具--Sandcastle和Sandcastle Help File Builder来实现API文档自动化吧!

根据标准word模板生成word文档类库(开源)

前言                                                                                                                              最近因项目需要要自定义标准word模板,并以编码方式操作word模板.填充数据和生成word文档,于是自己写了条小"内裤"来实现这个功能.该"内 裤"只针对ooxml格式的word文档,当然大家可以用Aspose.

php生成word文档

利用php生成word文档,生成的word文件可以用word,wps等软件打开.具体代码如下: function word($data,$fileName=""){ if(empty($data)) return ""; $data="<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:off

利用php生成word文档

  利用php生成word文档,生成的word文件可以用word,wps等软件打开.具体代码如下: function word($data,$fileName=""){ if(empty($data)) return ""; $data="".$data.""; if(empty($fileName)) $fileName=date("YmdHis").".doc"; $fp=fopen

weiapi2.2 HelpPage自动生成接口说明文档和接口测试功能

原文:weiapi2.2 HelpPage自动生成接口说明文档和接口测试功能 在开发Webapi项目时每写完一个方法时,是不是需要添加相应的功能说明和测试案例呢?为了更简单方便的写说明接口文档和接口测试HelpPage提供了一个方便的途径. 她的大致原理是:在编译时会生成.dll程序集和.xml程序集说明文件,通过xml文件获取Controller名称.action名称.参数信息和备注信息等.这样接口说明文档就可以放到备注信息了,个人觉得确实粗暴简单 .那接口测试在哪呢?这里用到nuget第三方

《Cocos2D-x权威指南》——2.4 使用Doxygen工具生成Cocos2D-x文档

2.4 使用Doxygen工具生成Cocos2D-x文档 Doxygen是一种开源跨平台的工具,其功能是从程序源代码中抽取类.方法.成员的注释,形成一个和源代码配套的API(Application Programming Interface,应用程序编程接口)帮助文档.Doxygen工具完全支持C.C++.Java.Objective-C等语言,部分支持PHP.C#. Doxygen可以根据代码中的注释,按照规则生成相应的文档.Cocos2D-x的代码就依照了它的规则,并且提供了doxygen.

eclipse中自动生成javadoc文档的方法_java

本文实例讲述了eclipse中自动生成javadoc文档的方法.分享给大家供大家参考.具体方法如下: 使用eclipse生成文档(javadoc)主要有三种方法: 1. 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Javadoc Generation对话框中有两个地方要注意的: javadoc command:应该选择jdk的bin/javadoc.exe destination:为生成文档的保存路径,可自由选