apidoc

1. 由于apidoc依赖node.js的包管理工具npm进行安装，所以安装apidoc之前要先安装node.js（npm会在安装node时顺带进行安装）。 2. node -v node.js安装成功后会显示版本信息。 3. npm install apidoc -g 安装apidoc。 4. apidoc -v 安装成功后会显示版本信息。 来源： CSDN 作者： 忘妄 链接： https://blog.csdn.net/weixin_41771362/article/details/104170986

本章要点： Javadoc指令使用详细介绍 关于标识符和关键字 Javadoc指令使用详细介绍 java里面的注释分单行注释、多行注释和文档注释。这里重点讨论javadoc 指令的实际使用。 1.单行注释： 使用双斜线"//"放在需要注释的内容之前 2.多行注释：使用"/ “注释开始，” /"注释结束。 3.文档注释：文档注释以"/**"开始， ​ 以"*/" 结束。 下面使用三个简单的案例介绍如何使用javadoc工具生成API文档。 案例1：javadoc命令生成简单的API文档： 1）来到JavadocTest.java和Test.java所在的路径 文件内容如下： 2）执行以下命令 $ javadoc -encoding GBK -d apidoc -windowtitle 测试 -doctitle 使用javadoc工具生成API文档 -header 我的类 *Test.java 参数解释： -encoding : javadoc执行时的编码指令，因为JavadocTest.java和Test.java中含有中文，所以要设置成GBK编码，否则会包“utf-8 不可编码”的错误 -d: 设置生成的API文档的路径，这里写“apidoc”会在当前路径处生成一个apidoc文件夹 -windowtitle:为api文档的浏览器窗口设置字符串标题。 -doctitle

在开发接口的过程中，需要向外发布相应的接口文档。开始的时候使用word来写文档，时间长了发现有几个问题。 1. 编写不方便。每次新增借口的时候都要复制上一个接口，然后再进行修改，一些相同的部分无法复用，接口多了文档会变的很长，还经常需要调整格式。 2. 发布不方便。文档更新时，需要发给需要的小伙伴。即使用git来进行管理，虽然拉取比较方便，但由于文件格式的问题，也不方便比较两次提交的差异。 由于有这些问题，决定寻找一种更优雅有效的方式来编写文档。经过比较，发现了apidoc,可以比较好的解决上面提到的问题。apidoc采用了一种类似写代码注释的方式来写文档，支持编写多种语言的文档。最后生成的文档以网页的形式发布，方便快捷，便于阅读。下面就来简单介绍一下怎么使用apidoc来写文档。 安装 1. 由于apidoc依赖node.js的包管理工具npm进行安装，所以安装apidoc之前要先安装node.js（npm会在安装node时顺带进行安装）。具体的安装教程可以参考 这里 。 2. 安装完了npm之后，就可以安装apidoc了。在命令行输入 npm install apidoc -g 就可以进行安装了。安装完成输入 apidoc -h 出现相关的提示帮助信息，说明安装成功了。 使用 1. 在需要生成文档的地方新建一个apidoc.json文件,配置如下 { "name":

目录 安装环境 开始使用 apidoc.json test.php 安装环境 安装nodejs和npm 进入官网 https://nodejs.org/en/ 下载首页推荐的版本就可以 安装完成后 node - v v8 . 12.0 说明安装成功,安装nodejs的同时，一并会把npm也替我们安装好，同样使用cmd查看npm版本 npm - v v6 . 4.1 安装完成~ 安装apidoc 使用npm进行安装 npm install apidoc - g 使用apidoc -h 可以查看帮助 说明安装成功 开始使用 使用apidoc (PHP项目为例) 新建一个项目或者在老项目根目录创建 apidoc.json 文件 apidoc.json { "name" : "appleFarm" , //文档项目名 "title" : "appleFarmAPI" , //html标题 "description" : "appleFarmAPI接口文档" , //文档描述 "url" : "https: //xxx.com" , //公共接口地址 "version" : "0.1.0" //文档版本 } 创建src目录,新建 test.php 文件 添加apidoc注释 test.php class Home { /** * 定义一个变量 用于apiGroup 因为不支持直接输入中文 *

在项目开发过程中，总会涉及到接口文档的设计编写，之前使用的都是ms office工具，不够漂亮也不直观，变更频繁的话维护成本也更高，及时性也是大问题。基于这个背景，下面介绍几个常用的API管理工具，方便你与调用方更高效的沟通测试： Swagger 官网地址：https://swagger.io Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件，是一个规范和完整的框架，标准的，语言无关，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。 目前最新版本是V3，SwaggerUI是一个简单的Restful API 测试和文档工具。简单、漂亮、易用。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。 RAP 官网地址：http://rapapi.org/org/index.do RAP来自阿里巴巴，是一个可视化接口管理工具 通过分析接口结构，使用mock动态生成模拟数据，校验真实接口正确性， 围绕接口定义，通过一系列自动化工具提升我们的协作效率。可以在线使用

Apidoc的安装配置及使用 Apidoc的安装配置及使用 1.什么是Apidoc 2.友好的文档展示页面 3.注释生成接口文档的原理 4.Apidoc安装 5.Apidoc使用 6.常用Apidoc注释规则举例 7.PHPstorm中设置配置参考 Apidoc的安装配置及使用 1.什么是Apidoc Apidoc是一款可以由源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的所有风格的注释。可以在C#, Go, Dart, Java, JavaScript, PHP, TypeScript等语言中使用 2.友好的文档展示页面 3.注释生成接口文档的原理 apidoc的原理是扫描你的代码文件，提取出注释部分，根据一些规则生成相应的文档。默认的模板久简洁美观，十分适合作为api文档的生成器。 4.Apidoc安装 环境：需要使用npm安装，如果没有安装npm，请先去https://www.npmjs.com/下载npm并且安装。npm官网需要注册账号，另一种方式是安装node，会自动安装npm工具 安装node教程 安装: npm install apidoc -g 验证安装是否成功： # 出现帮助信息则安装成功 apidoc -h 配置apidoc.json文件： { "name" : "appleFarm" , //文档项目名 "title" :

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> JDK API 帮助文档 : JDK 5 : Java SE 5 API 中文版 CHM 下载:http://download.java.net/jdk/jdk-api-localizations/jdk-api-zh-cn/builds/JDK_API_1_5_zh_CN.CHM JAVASE5 EN Downloads: http://javadoc.allimant.org/dist/jdk150.zip JDK 6 : JDK6 API 中文版下载: https://jdk-api-zh-cn.dev.java.net/ JDK6 API 中文版 HTML 格式在线文档：http://download.java.net/jdk/jdk-api-localizations/jdk-api-zh-cn/builds/latest/html/zh_CN/api/ JDK6 API 中文版zip 格式下载： http://download.java.net/jdk/jdk-api-localizations/jdk-api-zh-cn/builds/latest/html_zh_CN.zip JDK6 API CHM中文参考下载:http://chinesedocument.com/upimg/soft

开源的api文档管理系统 api文档 php 在项目中，需要协同开发，所以会写许多API文档给其他同事，以前都是写一个简单的TXT文本或Word文档，口口相传，这种方式比较老土了，所以，需要有个api管理系统专门来管理这些api，从网上找了许多比较好的开源文档管理系统，可以应用到项目中。 1、国外的话 Swagger swagger-ui 2、国内的 Showdoc 国内开源的非常好用的一款API文档管理系统，安装也非常方便，只需将源代码放到项目目录下自动安装运行即可，不要要注意PHP版本必须大于5.3. 3、界面简洁功能强大的 EOAPI 4、 阿里的RAP Web API management, free and open sourced, mock data generator, auto test, made by Alibaba, using by 1000+ corporations! Web接口管理工具，开源免费，接口自动化，MOCK数据自动生成，自动化测试，企业级管理。阿里妈妈MUX团队出品！阿里巴巴都在用！1000+公司的选择！一直被抄袭，从未被超越 :3 http://rapapi.net 5、 postMan 6、 docute: 无需编译的文档撰写工具 像 gitbook 之类的工具需要编译后发布，而 docute 让你直接写 markdown

你的项目在用什么工具书写api文档？今天就来给大家推荐下ApiDoc 1. ApiDoc是什么？ ApiDoc可以根据你再代码里的注释，来生成api描述文档，这样就不用你自己去告诉端的小伙伴该怎么调用你的api了。目前支持的变成语言有：Java，Javascript，Php，Python,C#,Ruby,Lua等，主流的编成语言都支持。 2. 怎么用？ 很简单，只要在你的代码里用这样的注解申明你的接口信息就好 /** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */ 这里面的这些注解都是ApiDoc定义好的，你只要按照官方文档使用就好了。 ApiDoc 官网 3. 开始搞起来 安装 npm install apidoc -g 运行 apidoc -i api/ -o docs/ api是你的代码目录也就是你使用注释的文件目录，它会自动扫描使用注解的文件

laravel-doc ⛵ laravel-doc 是一个用来生成文档，通过markdown来撰写文档，并提供web访问文档的项目 安装要求 PHP >= 7.0.0 Laravel >= 5 安装 composer require foryoufeng/laravel-doc 如果你是运行的Laravel 5.5以下的版本，需要在 config/app.php 的service provider中添加： Foryoufeng\Doc\DocServiceProvider::class 运行如下命令来发布资源文件 php artisan doc:install 发布资源之后会多出很多文件 /public/vendor/laravel-doc //样式文件 /resources/views/docs //界面文件 /resources/mds/docs //文档文件 /resources/mds/apidocs //api文件 /app/Http/Controllers/Docs //增加了控制器文件 config/laravel_doc.php //文档配置文件 routes/web.php中增加了路由文件 访问 /doc ,即可看到本项目的说明文档 访问 /apidoc ,即可看到本项目的接口说明文档 如何使用 普通文档的编写 在 resources/mds/docs