apidoc(iOS)安装与使用
apidoc(iOS)安装与使用
saber森森 发表于2年前
apidoc(iOS)安装与使用
  • 发表于 2年前
  • 阅读 32
  • 收藏 0
  • 点赞 1
  • 评论 0

标题:腾讯云 新注册用户域名抢购1元起>>>   

摘要: 公司需求 挺坑的 但是成功了 还是很强大的

Apidoc安装与使用

一.安装Apidoc

1.首先先从https://github.com/apidoc/apidoc 上下载demo

2.在终端执行npm install apidoc –g 如果执行失败跳到步骤3,执行成功跳到步骤二.

3.安装npm  首先先安装Homebrew 在终端ruby -e "$(curl –fsSL 

https://raw.githubusercontent.com/Homebrew/install/master/install)"

4.执行成功 终端输入 brew install node 等待一段时间

5.执行成功 终端输入npm –v 确认是否npm安装成功

6.安装npm成功,跳到步骤二2

二.测试demo

   1.通过终端进入下载的demo目录下。

2.执行终端命令apidoc -i example/ -o doc/  执行成功就则会在该目录下生成doc文件。

 

三.Teacher项目测试(iOS

   1.在目录下创建个json文件

   2.创建成功后就可以通过终端找到该目录然后执行

iOS:  apidoc -f ".*\\.h$" -f ".*\\.m$"

安卓:apidoc -f ".*\\.java$"

(其他后缀可以在后面加 比如 apidoc -f ".*\\.php$" -f ".*\\.xml$"

   3.执行结果生成了doc文件里面有个html文件点击后

   4.测试备注如下:

 /**

 *

 * @api {get} v2/updateDeviceToken.json

 * @apiDescription 更新DeviceToken

 * @apiGroup APIManager

 * @apiName updateDeviceToken

 * @apiParam {NSString} deviceToken 用户设备号

 * @apiVersion 3.2.1

 *

 *

 * @apiExample {curl} 访问示例:

 * curl -i http://data.fclassroom.com/v2/updateDeviceToken.json

 *

 * @apiSuccess {Int} code 请求成功code0

 */

- (void)updateDeviceToken:(NSString *)deviceToken;

 


共有 人打赏支持
粉丝 0
博文 2
码字总数 696
×
saber森森
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: