如何整理开发项目的doc接口文档和数据库的数据字典?

不动代码和接口,如何用swagger整理开发项目的doc接口文档?(亲测可用)

1.找到项目的swagger,把swagger-ui替换成doc,后缀结尾依然是.html,然后放到Google搜索框里,然后回车,看到新的一个界面
2.左上角可以选择自己的项目名称
3.找到文档管理,点离线按文档(MD),然后拷贝文档
4.Mac下有一个文本编辑的工具,打开然后保存空的到桌面,文本格式默认是.rtf结尾
5.修改桌面刚刚保存的文件格式。把后缀名.rtf结尾修改为md结尾,并保存
6.打开.md文件清空无用的东西,把之前从离线文档拷贝的东西复制进去
7.找到md转docx的工具,这里我选用的是 https://cloudconvert.com/md-to-docx
8.找到转换工具,选择文件进行兑换转换,然后下载,即可完成swagger上所有接口的文档整理

如何整理数据库的数据字典?

select column_name as '列字段名',
column_type as '列字段类型',
column_key as '字段约束类型',
is_nullable as '是否非空',
column_comment as '字段说明'
from information_schema.columns 
 where table_schema='数据库名字' and table_name='表名字';

利用如上sql查询语句,就可以把数据库下的所有表一一整理出来,然后再整理到Excel表中,就清晰明了了。整理的结果示例图:
在这里插入图片描述
看到结尾处的小伙伴,记得一键三连哦~~

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值