API Doc

apidoc命令行生成接口文档

浪尽此生 提交于 2020-08-12 01:15:08
安装运行: node.js中文网下载安装:http://nodejs.cn/ 1、安装npm环境 2、运行下载apidoc:npm install apidoc -g 3、在需要生成注释的文件目录增加 “apidoc.json”文件,文件内容如下: { "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "title": "Custom apiDoc browser title", "url" : "https://api.github.com/v1", "sampleUrl":"xxx" } 4、运行命令:apidoc 5、运行生成静态接口命令:apidoc -i src -o doc 说明:src 文档注释读取来源 doc 文档生成目录 6、在文件夹 docapi中点击 index.html页面,查看接口文档 项目中增加apidoc: 1、新建apidoc文件夹和src同目录 2、apidoc文件夹下增加生成目录doc文件夹 和文件 apidoc.json apidoc.json文件内容: { "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "title":

Java记录

半世苍凉 提交于 2020-05-06 00:59:36
代码片段: https://gitee.com/feistel/codes/m3u8qks6tv5cynrd2azjb75 ----------------------------------------------------------------- Java编译文档: javadoc -d ./apidoc -windowtitle 标签页标题 -doctitle API文档标题 -header 我的类 -version -author liuguanliang ----------------------------------------------------------------- java.lang:(Java默认引入的包) 1.8个类型包装类继承自java.lang.Number,实现java.io.Serializable,java.lang.Comparable<T> 1)java.io.Serializable,强烈建议 所有可序列化类都显式声明private serialVersionUID。 2)java.lang.Comparable<T>,public int compareTo(T o),小于、等于或大于指定对象,则分别返回负整数、零或正整数。 3)java.lang.Number,XXXValue() * String还实现了java.lang

从0开始学习接口自动化测试(一)

烂漫一生 提交于 2020-04-28 12:49:25
从0开始学习接口自动化测试 感兴趣的小伙伴可以加入QQ群:556029945 前言  最近项目空档期,寻思着反正没什么事情,不如把自己做过的东西做一些总结,然后找个地方记录一下,给测试行业的入门的小伙伴们看一下,点点点到了一定的时候,就想做点觉得高大上的技术(自动化测试),但是会很懵逼,不知道从何开始,就想如果有个人带带就不错,所以希望这些总结能够给你们一些启示。<br>  说明一下,本文是讲述如何开展自动化测试,更多的一个自动化测试实践,而不是框架,如果是框架学习的同行或爱好者,请私下联系交流。本文主要是讲的接口相关的,不是属于UI的,所以如果想了解UI自动化测试的,也可以私下交流,主要是考虑到点点点都是UI的,想必大家都不陌生。 什么是接口  原谅我也要百度一发,接口的概念,百度百科里面说: 接口(硬件类接口)是指同一计算机不同功能层之间的通信规则称为接口。 接口(软件类接口)是指对协定进行定义的引用类型。其他类型实现接口,以保证它们支持某些操作。接口指定必须由类提供的成员或实现它的其他接口。与类相似,接口可以包含方法、属性、索引器和事件作为成员。 看完之后不经说一声,我还是不懂,到底什么事接口。<br> 我们来看一下开发同事提供的接口文档,看能不能知道什么是接口,最后发现公司业务属于机密,不便公开,脱敏有需要修改数据,挺麻烦,还好网上有人分享了一个swagger的

如何用环信SDK一步一步实现视频会议(详细版)

浪尽此生 提交于 2020-04-12 07:39:07
如何用环信SDK一步一步实现视频会议(详细版) 今年是不平凡的一年,没错,就是因为疫情,因为疫情原因 ,大家只能呆着家里,严重影响了我们正常的学习 生活 工作,在这种情况下,只能在家办公,这时候大家就会想到线上视频会议,目前很多互联网公司有这个产品,比较出名的就比如 腾讯会议 钉钉 zoom等,用这些是很方便,但是如果能开发自己的视频会议,那会不会更好或者是更有成就感,下面简单介绍这个这个项目,和大概的开发过程。 本项目基于环信音视频云实现,主要功能有:创建会议、删除会议、获取指定会议室详情、加入会议室、退出会议室等关于会议的管理 ;还有获取会议室参会人名列表、踢人,设置观众为主播,设置主播为观众等关于会议室的人员管理,目前这些功能在项目中都已经实现,还有关于共享桌面,水印 ,变声功能 SDK接口内部都已经封装好,本项目没有实现 ,大家可以自行去实现,有关多人音视频功能详细介绍大家 可以参考 : http://docs-im.easemob.com/im/other/integrationcases/meeting 。多人音视频实现的实现主要有以下一些场景:社交交友,远程心理咨询、远程医疗、一对一在线教育、远程视频辅助等。咳咳 ,接下来就是纯干货了,给大家介绍我是如何一步步开发出一个完整的多人音视频app。 项目截图 首先给大家展示下项目运行的效果图,会议界面 主窗口是一个大的

C# CefSharp参考资料

南笙酒味 提交于 2020-03-22 22:15:57
3 月,跳不动了?>>> https://github.com/cefsharp/cefsharp https://github.com/cefsharp/CefSharp/wiki CefSharp API Doc CefSharp中文帮助文档 https://www.cnblogs.com/TianFang/category/1332897.html Add AnyCPU Support 来源: oschina 链接: https://my.oschina.net/u/2400070/blog/3208396

tp5 swagger-ui文档生成

扶醉桌前 提交于 2020-02-29 09:29:58
如何生成swagger-ui需要的json或者yaml的文件? tp5根目录, composer require zircote/swagger-php 方案1: 有需要的时候手动执行命令生成api_doc.json文件 添加命令 application/command.php 新增一行: \app\common\command\run\AutoCreateApiDoc::class , 就可以执行 php think run:autoCreateApiDoc 手动生成swagger json配置文件, 配置文件所在路径 public/api_doc.json /** * Created by querying. * Date: 19-2-20 * Time: 下午5:15 */ namespace app\common\command\run; use function \OpenApi\scan; use think\console\Command; use think\console\Input; use think\console\Output; use think\facade\App; class AutoCreateApiDoc extends Command { protected function configure() { $this->setName("run

【四 Twirl模板引擎】 1. 模板引擎

ε祈祈猫儿з 提交于 2019-11-30 05:29:35
基于Scala的类型安全的模板引擎 Play提供了基于Scala的强大模板引擎Twirl。它的诞生灵感来自于 ASP.NET Razor。它有如下特点: 简洁、流畅、富于表现力 :它能让你尽可能少的打字,同时提供了一个快速流畅的编码体验。与很多其他模板引擎不同之处在于在HTML中不会有服务端的代码块来打断编码节奏。聪明的解析器会自动推断出期望的结果,这种好处带来的直接后果就是简洁而干净的代码,快速,且富于乐趣。 易上手 :只包含了一些简单的概念,让你很快就能上手写代码。你可以使用简单的Scala结构和所有现有的HTML技能。 不是一个新语言 :我们特意选择了不创造一门新的语言。而尽可能的保留了Scala语言的特性,通过模板标记语法来支持一个出色的HTML构建工作流。 文本编辑器友好 :不需要任何特殊的工具,使用普通的文本编辑器也可以出色的工作。 注意 :虽然模板引擎使用了Scala作为描述语言,这对Java开发者来说也不是问题。你可以像使用Java那样来用它。记住不要在模板中写复杂的业务逻辑。这里不需要复杂的Scala代码,大多数情况下你只需要接受数据而已,如: myUser.getProfile().getUsername()。 参数类型通过前缀来限定。泛型使用[],而不是Java的<>。如List[String]相当于Java里面的List<String>。 模板需要经过编译