API接口文档生成方案调研

1. def isWindows() {
2. return org.gradle.internal.os.OperatingSystem.current().isWindows()
3. }
4. String apidocCmd = isWindows() ? 'apidoc.cmd' : 'apidoc'
5. task apidocs(type: Exec, description: '执行生成apidoc文档操作') {
6. workingDir './'
7. def docCommand = [apidocCmd, '-o', './build/apidocs']
8. commandLine docCommand
9. }

1. {
2. "name": "springboot-sample接口文档",
3. "version": "1.0.0",
4. "description": "",
5. "title": "springboot-sample",
6. "url" : "https://demo.test.com"
7. }

1. /**
2. * @apiVersion 1.0.0
3. * @api {GET} /group/front/getOutlinePaySuccessInfo 获取支付成功数据
4. * @apiGroup TransferAccount
5. * @apiName getOutlinePaySuccessInfo
6. * @apiParam (请求参数) {String} orderID 订单号
7. * @apiParam (请求参数) {String} partnerCode 渠道code
8. * @apiParam (请求参数) {String} sign 签名
9. * @apiParamExample 请求参数示例
10. * ?orderID=G0000168752925895356416&partnerCode=wyxx&sign=064d8cc51ed0957839e62f6684a4fe5c
11. * @apiSuccess (响应参数) {String} accountName 收款人
12. * @apiSuccess (响应参数) {Number} insuredNum 被保人数量
13. * @apiSuccess (响应参数) {String} returnUrl 跳转地址（可能为空）
14. * @apiSuccess (响应参数) {Number} validStartDate 开始时间
15. * @apiSuccess (响应参数) {Number} validEndDate 截止时间
16. * @apiSuccessExample 响应示例
17. * {"code":200,"msg":"成功","data":{"groupName":"微易测试","insuredNum":5,"returnUrl":"http://www.baidu.com","validStartDate":1524127875000,"validEndDate":1524127875000}}
18. */

1. /**
2. * @apiVersion 1.0.0
3. * @api {method$END$} path title
4. * @apiGroup name
5. * @apiName name
6. *
7. * @apiParam (请求参数) {type} field description
8. * @apiParam (请求参数) {type} field=defaultValue description
9. * @apiParamExample 请求参数示例
10. * example
11. *
12. * @apiParam (请求体) {type} field description
13. * @apiParam (请求体) {type} field=defaultValue description
14. * @apiParamExample 请求体示例
15. * example
16. *
17. * @apiSuccess (响应参数) {type} field description
18. * @apiSuccess (响应参数) {type} field description
19. * @apiSuccessExample 响应示例
20. * example
21. *
22. */

文章出自：http://blog.suiyiwen.com/post/4

文章来源: API接口文档生成方案调研