本文目录一览：
- 1、windows 下怎么使用 apidoc 生成文档
- 2、apidoc文档使用方法
- 3、apidoct接口文档参数提交格式问题
- 4、如何生成JavaAPI doc
- 5、apidoc怎么使用？怎么在myeclipse生成接口文档？
- 6、如何优雅的“编写”api接口文档
windows 下怎么使用 apidoc 生成文档
1、安装nodejs，nodejs里有npm，记得勾上
2、开始-运行-cmd， npm install apidoc
3、使用apidoc：
例如： node C:\Users\Administrator\node_modules\apidoc\bin\apidoc -i C:\xampp\htdocs\Application -o C:\xampp\htdocs\apidoc
ok。 实测能生成文档。
apidoc文档使用方法
0、本项目以laravel框架为例；
1、安装： （安装完成后所有位置都能执行相关命令）；
2、项目根目录创建apidoc.json文件；
3、控制器中编写对应的文档信息；
4、根目录执行命令生成文档；
1、安装根据官网教程即可；
2、项目根目录创建对应的json文件；内容如下
3、控制器中编写对应的文档信息；(注释部“/**/”分为文档生成的内容)
4、根目录执行命令生成文档；
app/Http/Controllers/Admin —需要生成文档的控制器地址
public/apidoc/admin —生成的文档保存位置
apidoct接口文档参数提交格式问题
方法一 每次请求: @apiHeader {string} Content-Type 请求数据格式
在接口文档的注释中加入,这样在填写表单时会多一个Content-Type
Content-Type 值填写application/json
方法二 全局:找到apidoc模版send_sample_request.js
一般在C:\Users\电脑用户名\AppData\Roaming\npm\node_modules\apidoc\template\utils
将ajax form表单的提交请求中加入三条
dataType: “json”,
contentType: “application/json”,
data: JSON.stringify(param),
如何生成JavaAPI doc
在代码里用文档注释方法进行注释
/**
* 注释内容
*/
用cmd进去源代码文件目录
输入指令javadoc -d MyAPIdoc xxx.java
敲回车就能在该目录下生成文件了，这是比较简单的一句话，当然还可以附加其他参数设置标题等。进生成目录双击index.html就能看到自己的文档了…
apidoc怎么使用？怎么在myeclipse生成接口文档？
先按照平常软件的安装方法安装,记住你的安装目录,下面说下破解;
破解步骤:
0:运行 run.bat
1. 输入Usercode, 点击’SystemId…’, 生成SystemId
2. 点击’Active’, 生成LICENSE_KEY, ACTIVATION_CODE, ACTIVATION_KEY
3. 点击菜单’Tools – 2.SaveProperties…’,
4. 点击菜单’Tools – 1.ReplaceJarFile’, 选择${eclipse_home}/plugins目录, 等待30秒左右.
说明:${eclipse_home}/plugins是eclipse安装目录下有个pugins文件夹,,如果没有,在common下的plugins下.
执行以上4个步骤,破解成功.
如何优雅的“编写”api接口文档
一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据，可与PUT互换，语义上PUT支持幂等
PUT
用于新增数据，可与POST互换，语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成，有分隔符隔开
4. HTTP Body
描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例：
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样，需要描述请清除数据的类型。
另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例（重点都用红笔圈出来，记牢了）：
五、接口工具
推荐使用的是（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/152264.html
微信扫一扫 
支付宝扫一扫 