Model Explorer scans specified packages, generates PlantUML class diagrams from source codes and shows in a web UI. It provides ability to store the generated diagrams in the database, or simply show the current class diagram without using database for storage.
Usually for projects which have evolving domain models, development team might need to check the progress of the evolving. Model Explorer is designed for this goal.
- Add Model Explorer into your project.
Gradle
implementation group: 'io.github.jarryzhou', name: 'model-explorer', version: '0.1.0'Maven
<dependency>
<groupId>io.github.jarryzhou</groupId>
<artifactId>model-explorer</artifactId>
<version>0.1.0</version>
</dependency>
- Configure Model Explorer
model-explorer:
enable: true # Whether to enable Model Explorer. Default: true
scanPackages: # Packages to scan and generate class diagram
- com.test
- com.test2- Start your application and visit {Your site}/model-explorer to get to the web UI. Please make sure the page and the related static resources URLs are properly configured in your web security config.
If you would like to contribute to the Model Explorer project, please fork the repository and submit a pull request. If you find a bug or have a feature request, please create a new issue.
This project is licensed under the MIT License - see the LICENSE file for details.