闲聊

关于日常开发某些需求需要对外开放某些端口，编写端口文档的痛我不说相信大家都懂。

之前有看过swagger的生成方式，整个流程编写流程给我看湿了，实现太复杂而且界面不咋好看。最近实践apidoc整个过程简单高效。

apidoc介绍

apidoc是一款可以由源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的所有风格的注释。

apidoc安装

apidoc基于nodejs环境

安装

1	`npm install apidoc -g`

apidoc启动以及接入示例

在项目根目录创建apidoc.json

内容

{
  "name": "接口说明",
  "version": "0.1.0",
  "description": "擦亮眼睛看明白了嗷",
  "url": "http://localhost:1234/zxzencryption",
  "sampleUrl": "http://localhost:1234/zxzencryption"
}

为了快捷可以节省掉后面两个url的配置

对接口注释

/**
 * @api {get} /desEncryption   des加密
 * @apiName des加密处理
 * @apiGroup Des
 * @apiDescription des加密的接口
 * @apiParam code 需要加密的内容
 * @apiParamExample {json}
 * Request-Example 1:
 * {
 *      "msg":"-9H5Sm2crvnyY-2Q8NX_ug",
 *      "code":200
 * }
 * @apiSuccess 1
 */
@GetMapping("/desEncryption")
public AjaxResult desEncryption(HttpServletResponse response) throws Exception
{
    String source = "123";
    System.out.println("Excepted:" + source);

    String result = DesEncryptionTool.enCryptAndEncode(source);
    AjaxResult ajaxResult = AjaxResult.success(DesEncryptionTool.enCryptAndEncode(source));
    return ajaxResult;
}