Инструмент для генерации документации по базе данных

Простая настройка позволяет генерировать документацию по базе данных.

Способ использования:

1. Измените информацию о конфигурации базы данных в файле application.properties.
2. Измените информацию в свойствах application.generator в файле application.properties.
3. Запустите файл Application.java.
4. Формат сгенерированного файла: 2018-03-07_05-45-453.xls.

Используемые фреймворки:

1. Spring Boot.
2. Spring JDBC.
3. FreeMaker.

Поддерживаемые базы данных:

1. MySQL.

Типы поддерживаемых документов:

1. Word — выглядит не очень хорошо, но можно изменить документ (v.15 удалён, больше не поддерживается).
2. Excel — выглядит неплохо, можно изменить документ.
3. HTML — выглядит лучше всего, но нельзя изменить.

Как расширить поддержку большего количества баз данных:

1. Добавьте пакет драйвера базы данных в pom.xml.
2. Измените информацию о конфигурации базы данных в application.properties.
3. Создайте новый класс, который наследуется от cn.wuwenyao.db.doc.generator.dao.impl.AbstractDbInfoDao.
4. Добавьте новое перечисление в cn.wuwenyao.db.doc.generator.enums.DbType.

Как расширить поддержку дополнительных типов документов:

1. Создайте новый класс, который наследуется от cn.wuwenyao.db.doc.generator.service.impl.AbstractGeneratorServiceImpl.
2. Добавьте новое перечисление в cn.wuwenyao.db.doc.generator.enums.TargetFileType.

Журнал обновлений:

1. v1.0 — завершена базовая архитектура, поддерживается генерация документов формата Word.
2. v1.1 — оптимизирована архитектура, поддерживается создание документов Excel, которые выглядят немного лучше, чем документы Word (смеюсь).
3. v1.2 — поддерживается создание HTML-документов.
4. v1.3 — добавлена генерация индексной информации.
5. v1.3.1 — добавлен новый HTML-шаблон, оптимизирована скорость создания документов.
6. v1.3.2 — поддерживаются белый и чёрный списки, оптимизирован шаблон Excel.

Примеры изображений:

• Пример Excel: https://gitee.com/shiqiyue/dbDocGenerator/raw/master/doc/excel.gif.
• Пример HTML: https://gitee.com/shiqiyue/dbDocGenerator/raw/master/doc/html.gif.
• Пример HTML с меню: https://gitee.com/shiqiyue/dbDocGenerator/raw/master/doc/html-menu.gif.

Скачать примеры:

1. Пример документа Word: http://gitee.com/shiqiyue/dbDocGenerator/tree/master/doc/word-sample.doc.
2. Пример документа Excel: http://gitee.com/shiqiyue/dbDocGenerator/tree/master/doc/excel-sample.xls.
3. Пример HTML-документа: http://gitee.com/shiqiyue/dbDocGenerator/tree/master/doc/html-sample.html.