分类: 程序文档工具
-
本文探讨了从 Rap 迁移至 ShowDoc 的接口文档编写设计,分析了两者在 JSON 导入功能及参数层级展示上的差异。鉴于 ShowDoc 默认模板仅支持一级参数且无 JSON 导入功能,文章排除了京东文档中高难度的合并单元格方案,转而定制了支持多级参数的互动运营 API 接口模板,最终验证其显示效果符合预期,解决了多级参数的展示需求。
-
在 Rap 工具的使用中发现某接口文档的字号显示异常小于其他文档。经排查分析,定位原因为数据结构定义中的 object 标记丢失,随后决定将数据类型描述由 array 修改为 array。修改操作完成后,文档字号显示恢复正常,符合预期效果,成功解决了字号不一致的问题。
