文档章节

apidoc(iOS)安装与使用

saber森森
 saber森森
发布于 2016/03/01 15:43
字数 342
阅读 39
收藏 0

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;

 


© 著作权归作者所有

共有 人打赏支持
saber森森
粉丝 0
博文 2
码字总数 696
作品 0
程序员
Titanium UI之TableViews组件

TableViews 1、为tableView增加数据 2、Row的属性 3、自定义Row,Row组,Row Section 4、在TableView的搜索 5、TableView的事件 内容 Ti里面创建一个TableView,如下: 这是其包含的属性: ...

lifer
2012/11/02
0
0
使用apidoc文档神器,快速生成api文档

写完api接口,就需要编写api文档了,如果一个个手写的话就很麻烦,就得使用apidoc只需要通过写注释,就可以快速生成文档了。 安装 第一步先安装全局模块apidoc。 修改接口的注释 找到novel-a...

jilei786
06/14
0
0
RESTFul接口测试工具:Wisdom RESTClient

Wisdom RESTClient 是由个人所开发的一款自动化测试REST API的工具。 它可以自动化测试REST API并生成精美的测试报告,同时基于测试过的历史数据,可以生成精美的REST API文档。 使用注意事项...

niithub
05/01
0
0
KingWTD/mockcat

Mockcat 开发工具集 项目简介 Mockcat是一款前端与后台分离开发的简易的接口Mock数据工具。提供了mock数据的模块化管理,接口数据的定义(支持带注释的JSON数据,自带JSON数据编辑器),以及...

KingWTD
08/22
0
0
java线程实战:多线程下载(下)

多线程下载业务逻辑: 1、URL请求获取下载文件的大小、计算每个线程下载的起始位置 2、RandomAccessFile类在存储空间占位,随机访问流在多线程下可同时读写文件 3、开启线程,每个线程负责下...

javaer
09/14
0
0

没有更多内容

加载失败,请刷新页面

加载更多

面向对象类之间的关系

面向对象类之间的关系:is-a、has-a、use-a is-a关系也叫继承或泛化,比如大雁和鸟类之间的关系就是继承。 has-a关系称为关联关系,例如企鹅在气候寒冷的地方生活,“企鹅”和“气候”就是关...

gackey
38分钟前
1
0
读书(附电子书)|小狗钱钱之白色的拉布拉多

关注公众号,在公众号中回复“小狗钱钱”可免费获得电子书。 一、背景 之前写了一篇文章 《小狗钱钱》 理财小白应该读的一本书,那时候我才看那本书,现在看了一大半了,发现这本书确实不错,...

tiankonguse
今天
1
0
Permissions 0777 for ‘***’ are too open

异常显示: @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @ WARNING: UNPROTECTED PRIVATE KEY FILE! @ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ......

李玉长
今天
3
0
区块链10年了,还未落地,它失败了吗?

导读 几乎每个人,甚至是对通证持怀疑态度的人,都对区块链的技术有积极的看法,因为它有可能改变世界。然而,区块链技术问世已经10年了,我们仍然没有真正的用上区块链技术。 几乎每个人,甚...

问题终结者
今天
2
0
20180921 su与sudo命令、限制root用户通过ssh远程登录

su 命令 用户切换。 su # 切换到root用户su username # 切换到username用户# su 后面加-时,会初始化当前用户的各种环境su - username # 指定用户执行某些命令 su - -c "touch /tm...

野雪球
今天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部