jumiz-dbdoc

介绍

В процессе работы выяснилось, что написание документации по базе данных — это довольно трудоёмкий процесс. С одной стороны, нужно заниматься разработкой, с другой — поддерживать документацию и делиться ею. Чтобы решить эту проблему, я подумал: почему бы не просматривать документацию по базе данных онлайн, интегрировав её в проект? Таким образом, каждый разработчик сможет видеть самую свежую версию документации, и при этом не нужно будет отдельно её поддерживать. Достаточно выполнить небольшую настройку в классе сущности, чтобы всё заработало. Разве это не удобно?

Программная архитектура

Монолитная архитектура:

• bean-to-doc — модуль без зависимостей, можно сразу запускать;
• database-to-doc — требуется зависимость от базы данных.

Инструкция по установке

1. Можно просто запустить обычный Maven-проект.

Руководство по использованию

1. Здесь находится класс запуска org.jumiz.db.JumiZHttpServer.

Участие в проекте

Специальные навыки для Code Cloud