文档章节

apidoc(iOS)安装与使用

saber森森
 saber森森
发布于 2016/03/01 15:43
字数 342
阅读 45
收藏 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
程序员
私信 提问
圈友社交APP

项目描述 产品现状: 第一版本ios android都已经上线。 第二版本更新: 提供:1.提供后台接口,2.产品第一版本源码(android,ios) 接口文档: https://cloud.quanyou.tv/apidoc/ 产品原型:...

圈友APP
2016/12/25
5
3
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 资料汇总

https://github.com/apidoc/apidoc http://apidocjs.com/example/ https://github.com/apidoc/apidoc/blob/master/EXAMPLES.md http://apidocjs.com/#param-api-sample-request apidoc -i ap......

K68
2016/08/15
1
0
jQuery 1.11.3 和 2.1.4 发布,iOS 安全版本

jQuery 1.11.3 和 2.1.4 发布, 修复了 iOS 8.2 and 8.3上一个罕见的错误。 查看代码: https://code.jquery.com/jquery-1.11.3.js https://code.jquery.com/jquery-2.1.4.js 更多内容请看发......

oschina
2015/04/29
10.1K
19
使用apidoc文档神器,快速生成api文档

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

jilei786
06/14
0
0

没有更多内容

加载失败,请刷新页面

加载更多

EOS docker开发环境

使用eos docker镜像是部署本地EOS开发环境的最轻松愉快的方法。使用官方提供的eos docker镜像,你可以快速建立一个eos开发环境,可以迅速启动开发节点和钱包服务器、创建账户、编写智能合约....

汇智网教程
今天
8
0
《唐史原来超有趣》的读后感优秀范文3700字

《唐史原来超有趣》的读后感优秀范文3700字: 作者:花若离。我今天分享的内容《唐史原来超有趣》这本书的读后感,我将这本书看了一遍之后就束之高阁了,不过里面的内容一直在在脑海中回放,...

原创小博客
今天
14
0
IC-CAD Methodology知识图谱

CAD (Computer Aided Design),计算机辅助设计,指利用计算机及其图形设备帮助设计人员进行设计工作,这个定义同样可以用来近似描述IC公司CAD工程师这个岗位的工作。 早期IC公司的CAD岗位最初...

李艳青1987
今天
14
0
CompletableFuture get方法一直阻塞或抛出TimeoutException

问题描述 最近刚刚上线的服务突然抛出大量的TimeoutException,查询后发现是使用了CompletableFuture,并且在执行future.get(5, TimeUnit.SECONDS);时抛出了TimeoutException异常,导致接口响...

xiaolyuh
今天
8
0
dubbo 搭建与使用

官网:http://dubbo.apache.org/en-us/ 一,安装监控中心(可以不安装) admin管理控制台,monitor监控中心 下载 bubbo ops 这个是新版的,需要node.js环境,我没有就用老版的了...

小兵胖胖
今天
15
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部