eoLinker 新功能发布,增加了识别代码注释自动生成文档功能
发布于 24 天前 作者 wardennn 287 次浏览 最后一次编辑是 22 天前 来自 分享

产品地址:https://www.eolinker.com 开源代码:https://www.eolinker.com/#/os/download 在线生成代码注释工具:http://tool.eolinker.com/doc2code 注释生成文档脚本:https://github.com/eolinker/Code2Doc

eoLinker提供了从代码注释直接生成接口文档的功能,有效地将接口文档与代码实现了同步。本篇文章将详细介绍如何通过eoLinker的Python脚本程序来生成文档。

【必要条件】 eoLinker用户帐户 已经在线上版创建了一个项目 已经获取项目的Project_Key以及Secret_Key eoLinker注释生成文档脚本:https://github.com/eolinker/Code2Doc

【如何获取Project_Key以及Secret_Key?】 在项目概况页面,点击其他功能-自动生成文档按钮,会出现以下弹框,显示相关的Project_Key以及Secret_Key。 eioasddzidongshengcheng.jpg 【环境要求】 目前代码注释生成文档支持Python,需要安装2.7以上版本的Python,并且开启re、codes、requests模块。

【相关工具】 eoLinker自动生成文档脚本:https://github.com/eolinker/Code2Doc eoLinker在线生成代码注释工具:http://tool.eolinker.com/doc2code

【规范】 eoLinker拥有自己的文本标记语言(EOML),为了减少输入流程,请使用eoLinker提供的在线生成代码注释工具(http://tool.eolinker.com/doc2code)。 group,[必填],API分组名称 childGroup,[选填],子分组名称(归属于group之下) status,[必填],接口状态,work(启用)| maintain(维护)| abandoned(弃用) protocol,[必填],请求协议,http|https method,[必填],请求方式,post | get | put | delete | head | options | patch path,[必填],API地址 name,[必填],API名称 header,[选填],请求头部,内容使用{}包裹 name,头部名称 value,头部参数值 parameter,[选填],请求参数,内容使用{}包裹 name,参数名 type,参数类型,string | file | json | int | float | double | date | datetime | boolean | byte | short | long | array | object required,是否必填,true(是)|false(否) response,[选填],返回参数,内容使用{}包裹 name,参数名 description,描述 type,参数类型,string | file | json | int | float | double | date | datetime | boolean | byte | short | long | array | object required,是否一定返回,true(是)|false(否)

【例子一(使用/** /注解)】 / **

  • group = “父分组”;
  • childGroup = “子分组”;
  • status = “work”;
  • protocol = “http”;
  • method = “POST”;
  • path = “www.baidu.com”;
  • name = “测试”;
  • header = {name=“Accept-Charset”,value=“utf-8”};
  • header = {name=“Content-Type”,value=“application/xml”};
  • parameter = {name = “userID”, type = “string”, description = “用户ID”, required = true};
  • parameter = {name = “userName”, type = “string”, description = “用户名称”, required = true};
  • response = {name = “statusCode”,description = “状态码”, type = “string”, required = true}; */

【例子二(使用’’’或”””注解)】 ””” group = “父分组”; childGroup = "子分组" status = “work”; protocol = “http”; method = “POST”; path = “www.baidu.com6”; name = “测试”; header = {name=“Accept-Charset”,value=“utf-8”}; header = {name=“Content-Type”,value=“application/xml”}; parameter = {name = “userID”, type = “string”, description = “用户ID”, required = true}; parameter = {name = “userName”, type = “string”, description = “用户名称”, required = true}; response = {name = “statusCode”,description = “状态码”, type = “string”, required = true}; ”””

【配置文件】 project_key,项目key secret_key,密码key file_path,读取文件的目录路径,window系统请按照r"c:\test"或者"c:\test"写法写 file_suffix,读取文件的后缀名,比如php或py或java exclude_file,排除文件名 user_name,eoLinker用户账号 user_password,用户密码

【配置文件例子】 project_key = 'uwiuryomx3asudhcami3y498cy7m2’ secret_key = '7962h4s83asd’ file_path = 'C:\project\code_upload’ file_suffix = 'java’ exclude_file = [‘gitignore’,‘config.php’] user_name = 'test’ user_password = ‘123456’

完成以上配置之后,运行eolinker.py脚本既可自动生成文档,返回“成功”则自动生成成功,否则失败。

eoLinker是一个免费开源的针对开发人员需求而设计的接口管理工具,通过简单的操作来帮助开发者进行接口文档管理、接口自动化测试、团队协作、数据获取、安全防御监控等功能,降低企业的接口管理成本,提高项目的整体开发效率,支持自动化测试管理、权限管理、代码生成、团队协作,并且提供PC端产品以及浏览器增强插件,让接口管理更加简单。

4 回复

用户多不

来自酷炫的 CNodeMD

那么巧,今天刚关注 楼主就发贴了

@zswnew 多啊,建议加用户讨论群看看就知道了。群号 284421832

@dbit-xia 缘 妙不可言

回到顶部