现在有个需求,需要导出接口文档,有word和excel两种文档。
excel相对简单,现在poi对excel的支持很成熟了,网上案例也很多,我这里用的easypoi,注解形式放到实体类的字段上,就不多说excel的了。
导出word时,word需要动态生成每个接口的信息,每个接口中要动态生成每个对象参数列表,其实需求也不算复杂。
我先后用了easypoi和esayword,这两个都特别坑,导出的时候各种问题,特别是easyword,要用书签的形式,word模板动不动就不能生效。后来干脆放弃改用了poi-tl。不得不说这个对word导出的技术还是挺完善、成熟的。
标签的含义网上一堆,全是cv的官网的。。。
模板:所有的()为注释,实际模板使用记得要去掉,word的样式可以在模板里设置好,代码也可以设置,不过麻烦点。
{
{?interfaceInfos}}(区块对标签,就是循环生成接口信息)
2.{
{interfaceInfoVO.sort}} {
{interfaceInfoVO.name}}
基本信息
接口名称 {
{interfaceInfoVO.name}}
接口描述 {
{interfaceInfoVO.describe}}
数据格式 {
{interfaceInfoVO.dataType}}
请求方式 {
{interfaceInfoVO.requestType}}
接口URL {
{interfaceInfoVO.url}}
其他
服务编码 {
{interfaceInfoVO.code}}
设计负责人 {
{interfaceInfoVO.designerName}}
开发负责人 {
{interfaceInfoVO.developer}}
测试负责人 {
{interfaceInfoVO.tester}}
入参描述
{
{interfaceParamInList}}属性名称 类型 最大长度 是否必填 属性中文名称 属性备注 示例值
[enName] [type] [length] [requiredName] [cnName] [describe]
{
{?inParam}}(参数区块对,参数为对象时,要循环生成每个对象的列表)
{
{inFieldName}}对象描述
{
{inList}}属性名称 类型 最大长度 是否必填 属性中文名称 属性备注 示例值
[enName] [typ