ApiFormatMd 轻量级Java接口文档生成工具
特点
- 完全基于本地代码执行 Java代码无需引用额外依赖
- 生成MarkDown格式文档 可使用ShowDoc生成在线文档
配置项
main.py
- 作者 author = ‘江火似流萤’ (对应Md文档作者信息)
- 载入类根目录 root_path = r"/Users/xxx" (指定Java项目根目录,程序以此为起点遍历Java文件)
- 生成md文件目录 write_path = r"/Users/xxx/Desktop" (Md文档写入路径)
param.txt
- 参数 param.txt (Controller层接口信息 具体参考文件内容)
依赖
如何使用
方式一 生成文件到本地
- 本地安装python3环境
- clone本项目到本地
- 修改main.py ‘author’ ‘root_path’ 'write_path’配置(首次使用配置)
- API信息写入 param.txt 文件
- 执行
python3 main.py
终端输出 ‘success’ 则执行成功
方式二 生成文档到showDoc
- 基于方式一的配置 执行
python3 request_show_doc.py
- 打开 https://www.showdoc.com.cn/2040347871634336/ 查看文档
- 如果报错
ModuleNotFoundError: No module named 'requests'
需要导入request包执行 pip3 install requests
方式三 写入utools插件一键生成文档到showDoc
- utools 安装
一步到位
插件 - 创建自己的插件
![](https://i-blog.csdnimg.cn/blog_migrate/e0375b70f335d1ee0b351145eab52c3d.png)
- 复制接口到utools生成文档
- 复制接口
![](https://i-blog.csdnimg.cn/blog_migrate/845876677d496e229d6fb2d93f61c225.png)
- 粘贴到utools
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/5960dc4894f15f237157cb97c40e042e.png)
- 成功提示(文档地址已复制到粘贴板)
![](https://i-blog.csdnimg.cn/blog_migrate/b5eb331ff13f99e6317102cc9ad2134c.png)
- 浏览器打开文档
![](https://i-blog.csdnimg.cn/blog_migrate/b7f954842da9b341c3b62461265c9f4c.png)
例子
java接口
查看代码
@RequestMapping(value = "/v1/test/{userId}", method = RequestMethod.POST)
public JsonResult<List<Map<InvoiceVO.Extend, InvoiceVO>>> test(
@PathVariable(value = "userId") int userId,
@RequestParam(value = "roleCode", required = true) String roleCode,
@RequestBody QuoteStrategyRule quoteStrategyRule) {
return new JsonResult<>();
}
QuoteStrategyRule(参数)
package com.peng.model;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.Date;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@TableName("quote_strategy_rule")
public class QuoteStrategyRule implements Serializable {
@TableId(value = "id", type = IdType.AUTO)
private Long id;
private Long quoteStrategyId;
private Long resellerChannelId;
private Byte quoteStrategyCategory;
private Byte type;
private String name;
private Long refId;
private Date startDate;
private Date endDate;
private Byte priceType;
private Integer rate;
private Integer amount;
private Date createTime;
private Date updateTime;
private String operator;
}
InvoiceVO(返回主体)
@Data
public class InvoiceVO extends Invoice {
private Long invoiceNo;
private String invoiceTitle;
private InvoiceEnum invoiceEnum;
private ExtendSub extendSub;
@Data
public static class Extend {
private String title;
private String content;
}
@Data
public static class ExtendSub extends Extend {
private List<Spu> spuList;
private Spu spu;
private Map<String, Spu> spuMap;
private SpecialChannelEnum specialChannelEnum;
}
}
Invoice (InvoiceVO父类)
package com.peng.model;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.Date;
@JsonInclude(value = JsonInclude.Include.NON_NULL)
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@TableName("trade_invoice")
public class Invoice implements Serializable {
@TableId(value = "invoice_id", type = IdType.AUTO)
private Long invoiceId;
private Byte invoiceTitleType;
private Byte invoiceType;
private String name;
private String companyName;
private Byte status;
private String taxRegisterNumber;
private String invoiceCode;
private Long invoiceAmount;
private String registerAddress;
private String registerPhone;
private String bankName;
private String bankNo;
private String contactName;
private String contactPhone;
private String contactAddress;
private String contactEmail;
private String expressNo;
private String expressName;
private String fileUrl;
private String filePath;
private Integer supplierId;
private Integer ownerId;
private Integer userId;
private String remark;
private Boolean yn;
private Date createTime;
private Date updateTime;
private String createPin;
private String updatePin;
}
Spu(InvoiceVO.ExtendSub 依赖)
@Data
public class Spu implements Serializable {
private static final long serialVersionUID = 128833531741299945L;
private long id;
private byte productType;
private int productSubType;
private String nameCn;
private String nameEn;
private String poiIds;
private String name;
private String createPin;
private String updatePin;
private List<Key> keyList;
}
Key (Spu,Key 依赖)
@Data
public class Key implements Serializable {
private static final long serialVersionUID = 7585869752216827433L;
private Integer pageSize;
private byte type;
private String name;
private Map<String, String> names;
private List<Key> keyList;
}
生成内容
查看内容
接口说明
HTTP请求地址
- 地址:
http://domain//v1/test/{userId}
请求方式
参数说明
请求参数说明
返回参数说明
补充实体说明
QuoteStrategyRule
字段 | 类型 | 必填 | 说明 | 备注 |
---|
id | Long | - | - | - |
quoteStrategyId | Long | - | - | 所属策略ID |
resellerChannelId | Long | - | - | 所属渠道ID |
quoteStrategyCategory | Byte | - | - | 所属分类 1 生活服务;2 酒店业务;3 飞机票价 |
type | Byte | - | - | 引用ID,类型为1是0; 类型为2是大类枚举值; 类型为3是子类枚举值;类型为4商品ID;类型为5是规格ID;类型为6是规格ID |
name | String | - | - | 类型为1是【分类名称】; 类型为2是【分类名称>大类名称】;, 类型为3是【分类名称>大类名称>子类名称】;, 类型为4是【分类名称>商品id】;类型为5是【分类名称>商品id>规格id】;, 类型为6是【分类名称>商品id>规格id>开始时间~结束时间】 |
refId | Long | - | - | 引用ID,类型为1是0; 类型为2是大类枚举值; 类型为3是子类枚举值;类型为4商品ID;类型为5是规格ID;类型为6是规格ID |
startDate | Date | - | - | 生效时间,类型为6时有值否则为null,格式yyyy-MM-dd HH:mm:ss |
endDate | Date | - | - | 失效时间,类型为6时有值否则为nu,格式yyyy-MM-dd HH:mm:ss |
priceType | Byte | - | - | 加价类型 1百分比 2固定金额 |
rate | Integer | - | - | 加价百分比,当加价类型为1时,该字段有值 |
amount | Integer | - | - | 加价金额,当加价类型为2时,该字段有值 |
createTime | Date | - | - | 创建时间 |
updateTime | Date | - | - | 更新时间 |
operator | String | - | - | 操作人 |
InvoiceVO
字段 | 类型 | 必填 | 说明 | 备注 |
---|
invoiceId | Long | - | - | - |
invoiceTitleType | Byte | - | - | 发票抬头类型 1:个人 2:单位 |
invoiceType | Byte | - | - | 发票类型 1:国内纸质发票 2:国内电子发票 3:国际电子发票 |
name | String | - | - | 个人名称 |
companyName | String | - | - | 单位名称 |
status | Byte | - | - | 发票状态 1:处理中 2:已开发票 |
taxRegisterNumber | String | - | - | 纳税人识别号 |
invoiceCode | String | - | - | 发票编号 |
invoiceAmount | Long | - | - | 发票金额 |
registerAddress | String | - | - | 单位注册地址 |
registerPhone | String | - | - | 单位注册电话 |
bankName | String | - | - | 开户银行 |
bankNo | String | - | - | 银行卡号 |
contactName | String | - | - | 收件人姓名 |
contactPhone | String | - | - | 收件人手机号 |
contactAddress | String | - | - | 收件人地址 |
contactEmail | String | - | - | 收件人邮箱 |
expressNo | String | - | - | 快递单号 |
expressName | String | - | - | 快递公司 |
fileUrl | String | - | - | 发票电子文件地址 |
filePath | String | - | - | 发票电子文件地址 |
supplierId | Integer | - | - | 实际供应商id |
ownerId | Integer | - | - | ownerId |
userId | Integer | - | - | userId |
remark | String | - | - | 备注 |
yn | Boolean | - | - | 删除标识 |
createTime | Date | - | - | 创建时间 |
updateTime | Date | - | - | 更新时间 |
createPin | String | - | - | 创建人 |
updatePin | String | - | - | 更新人 |
invoiceNo | Long | - | - | 发票编号-子 |
invoiceTitle | String | - | - | 发票标题-子 |
invoiceEnum | InvoiceEnum | - | - | 发票类型-子 |
extendSub | ExtendSub | - | - | 扩展信息 |
JsonResult
字段 | 类型 | 必填 | 说明 | 备注 |
---|
code | Integer | - | - | code 为"0"则无异常 |
msg | String | - | - | msg |
data | T | - | - | data 返回体对象 |
Extend
字段 | 类型 | 必填 | 说明 | 备注 |
---|
title | String | - | - | 标题-父 |
content | String | - | - | 内容-父 |
InvoiceEnum
enum InvoiceEnum {
PERSON(1, "抬头为个人"),
COMPANY(2, "抬头为单位"),
BEING(1, "发票状态处理中"),
COMPLETE(2, "发票状态已完成"),
PAPER(1, "纸质发票"),
ELECTRONIC(2, "电子发票");
ExtendSub
字段 | 类型 | 必填 | 说明 | 备注 |
---|
title | String | - | - | 标题-父 |
content | String | - | - | 内容-父 |
spuList | List<Spu> | - | - | spu集合-子 |
spu | Spu | - | - | spu信息-子 |
spuMap | Map<String,Spu> | - | - | spu Map-子 |
specialChannelEnum | SpecialChannelEnum | - | - | 渠道枚举 |
Spu
字段 | 类型 | 必填 | 说明 | 备注 |
---|
id | long | - | - | 主键ID |
productType | byte | - | - | 商品类别 |
productSubType | int | - | - | 商品子类别 |
nameCn | String | - | - | spu中文名称 |
nameEn | String | - | - | spu英文名称 |
poiIds | String | - | - | poiId,按照poi_id顺序逗号分隔,eg:1,3,12 |
name | String | - | - | 业务字段 , 多语言处理后显示的name,v1.5.1新增 |
createPin | String | - | - | 创建人 |
updatePin | String | - | - | 更新人 |
keyList | List<Key> | - | - | key集合 |
SpecialChannelEnum
enum SpecialChannelEnum implements CommonEnum{
DEFAULT("DEFAULT", "默认渠道"),
SASS("SASS", "SASS平台"),
UNKNOWN("UNKNOWN", "UNKNOWN"),
;
Key
字段 | 类型 | 必填 | 说明 | 备注 |
---|
pageSize | Integer | - | - | - |
type | byte | - | - | 要素类别 |
name | String | - | - | 要素名称 |
names | Map<String,String> | - | - | 业务字段 , 要素名称多语言map, Map<languageCode, value> |
keyList | List<Key> | - | - | - |