首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

MySQL 表结构生成 Markdown 文档 | 工具篇

,当要将某一版本归档时,需要汇总的文档要求还是比较高的、各类文档齐全,包括项目架构、项目安装、接口等文档,而数据库表结构说明文档亦属于其一。...记得很早之前想找一个可以导出 MySQL 数据库表结构说明文档的工具,生态上的这种工具是有的、只不过并没有一个使我比较满足的。当然、看个人所需,我需要一个可以导出 markdown 文档的。...他只有一个功能、就是生成数据库表结构说明文档,格式为madkdown。...md2rtf md2openOffice md2Epub md2latex md2MediaWiki md2reStructureText md2textile md2OPML md2png 文档页面效果...生成的MD文件 [MySQL 表结构生成 Markdown 文档] MD文件转PDF [MySQL 表结构生成 Markdown转PDF 文档]

2.2K00
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    MYSQL数据库文档生成

    一、概述     平常会遇到编写文档类的工作,尤其是数据库的,要把每张表的详细字段列出来,手写实在费劲,从网上找了很多,都没有那种直接GUI输入参数,一键生成的,所以自己花时间做了一个,功能很简陋,但是基本需求可以实现...PrintWriter pw = new PrintWriter(sw);) { e.printStackTrace(pw); } return sw.toString(); } } 文档生成...ignoreTableName) .ignoreTablePrefix(ignorePrefix).ignoreTableSuffix(ignoreSuffix).build(); // 3、生成文档配置...").description("数据库设计文档生成") .dataSource(dataSource).engineConfig(engineConfig).produceConfig(processConfig...四、说明     目前实现的功能很简单,其实还可以增加如忽略表的功能,但现在用不到。

    4.4K20

    POSTMAN自动生成接口文档_swagger自动生成接口文档

    介绍 drf-spectacular是为Django REST Framework生成合理灵活的OpenAPI 3.0模式。...它可以自动帮我们提取接口中的信息,从而形成接口文档,而且内容十分详细,再也不用为写接口文档而心烦了 这个库主要实现了3个目标 从DRF中提取更多的schema信息 提供灵活性,使schema在现实世界中可用...(不仅仅是示例) 生成一个与最流行的客户端生成器配合良好的schema 环境准备 Python >= 3.6 Django (2.2, 3.1, 3.2) Django REST Framework...TITLE和DESCRIPTION和VERSION,如果想自定义更多的设置,请看文档 自定义接口内容信息 上面我们可以访问swagger接口文档,但是我们点开接口会发现没有任何内容信息 所以我们还需要在...summary:一个可选的短的总结描述 deprecated:将操作标记为已弃用 tags:覆盖默认标记列表 exclude:设置为True以从schema中排除操作 operation:手动覆盖自动发现将生成的内容

    2.3K20

    ReStructuredText 文档编写全攻略编写文档说明

    编写文档说明 学 python 的人一定会注意到很多python 文档都很相似,不管是整体风格还是结构组织方式都很类似。...将 rst 格式的文件转换成 html 等格式的文件,方便托管在服务器上,进行访问,依赖的工具有:sphinx sphinx 介绍 sphinx 是一个基于python的文档生成工具,许多 python...项目都用使用这个工具自动生成文档。...,先学会核心的这几个,遇到问题再针对性的查找: 比如:如何在文档内提供下载链接,点击链接就能进行下载 gitbook的使用 Gitbook 和 sphinx 有很多相似之处: 自动的生成文档 使用标记语言...客户端 前提需要安装: NodeJs npm install gitbook-cli -g 创建一个项目:初始化书本的目录 gitbook init 生成两个文件: README.md SUMMARY.md

    5.7K31

    生成flask接口文档

    背景 接触过几个针对flask自动生成接口文档的,但是感觉不太好用,然后发现了flask-docs,地址:https://github.com/kwkwc/flask-docs 但是感觉还是不太好用,...就进行了魔改 地址 https://gitee.com/heanny/flask-docs 添加的功能 可修改接口文档分类为中文 接口文档页面布局进行了优化美观 生成接口文档的方法进行了重构,并添加了部分兼容逻辑...添加了二级分类树 添加了html网页类型展示 修复部分问题 文档接口搜索已修复 测试页面接口及搜索已修复 form data可以使用,需要设置headers TODO 美化界面 增加的功能使用说明 中文类别...title="Sample App", version="1.0.0", description="A simple app API", ) doc.init_app(app) doc文档标题必须是第一行

    2.3K10

    swagger生成接口文档

    (https://swagger.io/) Spring Boot 可以集成Swagger,生成Swagger接口,Spring Boot是Java领域的神器,它是Spring项目下快速构建项目的框架。...2.Swagger常用注解 在Java类中添加Swagger的注解即可生成Swagger接口,常用Swagger注解如下: @Api:修饰整个类,描述Controller的作用 @ApiOperation...body 以流的形式提交 仅支持POST header 参数在request headers 里边提交 form 以form表单的形式提交 仅支持POST dataType 参数的数据类型 只作为标志说明...Swagger2Configuration类 2、在此类中指定了包路径com.xuecheng,找到在此包下及子包下标记有@RestController注解的controller类 3、根据controller类中的Swagger注解生成接口文档...启动项目,查看接口文档,请求:http://localhost:31001/swagger-ui.html 使用Swagger工具测试服务接口: 1)在cms服务接口中打断点 2)打开接口文档页面,输入请求参数

    1.3K30
    领券