文档章节

apidoc(iOS)安装与使用

saber森森
 saber森森
发布于 2016/03/01 15:43
字数 342
阅读 34
收藏 0
点赞 1
评论 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
程序员
使用apidoc文档神器,快速生成api文档

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

jilei786 ⋅ 06/14 ⋅ 0

RESTFul接口测试工具:Wisdom RESTClient

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

niithub ⋅ 05/01 ⋅ 0

如何使用反射来分析PHP的数据结构

更准备的说是 如何用PHP分析类内部的结构。 介绍 当我开始学习PHP编程时,可能并不知道 的强大功能,主要原因是我不需要它来设计我的类,模块甚至是包等等,但是它在很多地方都有非常不错的能...

如来神掌 ⋅ 06/02 ⋅ 0

Sphinx将python代码注释生成文档

安装 使用pip进行安装: pip install sphinx 初始化 进入你代码所在的目录,输入: sphinx-quickstart 下图:PRD是代码所在目录,生成的文档保存目录设成doc 下图:设置项目名称与作者,项目名...

武耀文 ⋅ 2017/06/13 ⋅ 0

Redis 的 Java 客户端 - Jedis

Jedis 是 Redis 官方首选的 Java 客户端开发包。 实例方法: import redis.clients.jedis.* Jedis jedis = new Jedis("localhost");jedis.set("foo", "bar");String value = jedis.get("foo"......

匿名 ⋅ 2011/04/01 ⋅ 3

基于 Groovy 的 Web 框架 - Grails

Grails 是一套用于快速 Web 应用开发的开源框架,它基于 Groovy 编程语言,并构建于 Spring、Hibernate 和其它标准 Java 框架之上,从而为大家带来一套能实现超高生产力的一站式框架。 Ruby...

匿名 ⋅ 2008/09/12 ⋅ 2

【AR】开始使用Vuforia开发iOS(2)

原 设置iOS开发环境 安装Vuforia iOS SDK 如何安装Vuforia iOS示例 编译并运行Vuforia iOS示例 支持iOS金属 iOS 64位迁移 设置iOS开发环境 适用于iOS的Vuforia引擎目前支持运行iOS 9及更高版...

lichong951 ⋅ 06/11 ⋅ 0

天生不凡ios怎么在电脑上玩 天生不凡ios电脑版玩法教程

天生不凡ios怎么在电脑上玩呢?现在有很多小伙伴都在玩天生不凡手游,不过相对于传统的在手机上进行游戏,很多人都倾向于新玩法,就是在电脑上玩天生不凡手游。下面小编就给亲们介绍下天生不...

kaopu8520 ⋅ 05/29 ⋅ 0

如何在Electra越狱的设备上使用LLDB调试应用程序

        在3月18日的时候,我就曾发表过一篇关于在Electra越狱的设备上使用LLDB调试应用程序的文章。本文我将在此基础上,做进一步的更新优化。   我试图在google搜索,有关使用Ele...

FreeBuf ⋅ 05/29 ⋅ 0

Appuploader的安装介绍

注意:下载AU后需安装java8运行环境才能启动;安装好了最新Java8运行环境,解压AU软件包,无需安装,Windows 64位系统点击appuploader.exe启动;如果是Linux/Windows 32位系统或Mac系统双击appuplo...

webmirror ⋅ 05/11 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

Centos7重置Mysql 8.0.1 root 密码

问题产生背景: 安装完 最新版的 mysql8.0.1后忘记了密码,向重置root密码;找了网上好多资料都不尽相同,根据自己的问题总结如下: 第一步:修改配置文件免密码登录mysql vim /etc/my.cnf 1...

豆花饭烧土豆 ⋅ 今天 ⋅ 0

熊掌号收录比例对于网站原创数据排名的影响[图]

从去年下半年开始,我在写博客了,因为我觉得业余写写博客也还是很不错的,但是从2017年下半年开始,百度已经推出了原创保护功能和熊掌号平台,为此,我也提交了不少以前的老数据,而这些历史...

原创小博客 ⋅ 今天 ⋅ 0

LVM讲解、磁盘故障小案例

LVM LVM就是动态卷管理,可以将多个硬盘和硬盘分区做成一个逻辑卷,并把这个逻辑卷作为一个整体来统一管理,动态对分区进行扩缩空间大小,安全快捷方便管理。 1.新建分区,更改类型为8e 即L...

蛋黄Yolks ⋅ 今天 ⋅ 0

Hadoop Yarn调度器的选择和使用

一、引言 Yarn在Hadoop的生态系统中担任了资源管理和任务调度的角色。在讨论其构造器之前先简单了解一下Yarn的架构。 上图是Yarn的基本架构,其中ResourceManager是整个架构的核心组件,它负...

p柯西 ⋅ 今天 ⋅ 0

uWSGI + Django @ Ubuntu

创建 Django App Project 创建后, 可以看到路径下有一个wsgi.py的问题 uWSGI运行 直接命令行运行 利用如下命令, 可直接访问 uwsgi --http :8080 --wsgi-file dj/wsgi.py 配置文件 & 运行 [u...

袁祾 ⋅ 今天 ⋅ 0

JVM堆的理解

在JVM中,我们经常提到的就是堆了,堆确实很重要,其实,除了堆之外,还有几个重要的模块,看下图: 大 多数情况下,我们并不需要关心JVM的底层,但是如果了解它的话,对于我们系统调优是非常...

不羁之后 ⋅ 昨天 ⋅ 0

推荐:并发情况下:Java HashMap 形成死循环的原因

在淘宝内网里看到同事发了贴说了一个CPU被100%的线上故障,并且这个事发生了很多次,原因是在Java语言在并发情况下使用HashMap造成Race Condition,从而导致死循环。这个事情我4、5年前也经历...

码代码的小司机 ⋅ 昨天 ⋅ 2

聊聊spring cloud gateway的RetryGatewayFilter

序 本文主要研究一下spring cloud gateway的RetryGatewayFilter GatewayAutoConfiguration spring-cloud-gateway-core-2.0.0.RC2-sources.jar!/org/springframework/cloud/gateway/config/G......

go4it ⋅ 昨天 ⋅ 0

创建新用户和授予MySQL中的权限教程

导读 MySQL是一个开源数据库管理软件,可帮助用户存储,组织和以后检索数据。 它有多种选项来授予特定用户在表和数据库中的细微的权限 - 本教程将简要介绍一些选项。 如何创建新用户 在MySQL...

问题终结者 ⋅ 昨天 ⋅ 0

android -------- 颜色的半透明效果配置

最近有朋友问我 Android 背景颜色的半透明效果配置,我网上看资料,总结了一下, 开发中也是常常遇到的,所以来写篇博客 常用的颜色值格式有: RGB ARGB RRGGBB AARRGGBB 这4种 透明度 透明度...

切切歆语 ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部