PlantUML Server 使用教程

PlantUML Server 使用教程

项目地址:https://gitcode.com/gh_mirrors/pl/plantuml-server

1. 项目的目录结构及介绍

PlantUML Server 是一个用于在线生成 UML 图形的开源项目。以下是其基本的目录结构：

plantuml-server/
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── target/
├── pom.xml
└── README.md

• src/main/java/：包含项目的主要 Java 源代码。
• src/main/resources/：包含项目的资源文件，如配置文件和静态资源。
• src/test/java/：包含项目的测试代码。
• src/test/resources/：包含测试所需的资源文件。
• target/：包含构建生成的文件，如编译后的类文件和打包的 JAR 文件。
• pom.xml：Maven 项目的配置文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

PlantUML Server 使用 Maven 进行构建和启动。主要的启动文件是 pom.xml，它配置了项目的依赖和构建过程。

启动命令

要启动 PlantUML Server，可以使用以下命令：

mvn jetty:run

这将启动一个嵌入式的 Jetty 服务器，并在 http://localhost:8080/plantuml 上监听请求。

Docker 启动

如果使用 Docker 启动 PlantUML Server，可以使用以下命令：

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

这将启动一个 Jetty 容器，并在 http://localhost:8080 上监听请求。

3. 项目的配置文件介绍

PlantUML Server 的配置文件主要位于 src/main/resources/ 目录下。主要的配置文件包括：

• application.properties：包含服务器的配置参数，如端口号、数据库连接等。
• log4j.properties：配置日志记录的参数。

配置示例

以下是一个简单的 application.properties 配置示例：

server.port=8080
plantuml.security.profile=INTERNET

环境变量

可以通过环境变量来配置 PlantUML Server。例如，设置基本 URL：

environment:
  - BASE_URL=plantuml

然后运行：

docker-compose up

这将启动一个使用 /plantuml 作为基本 URL 的修改版本。

通过以上步骤，您可以成功启动和配置 PlantUML Server，并根据需要进行进一步的定制和扩展。

plantuml-server PlantUML Online Server 项目地址: https://gitcode.com/gh_mirrors/pl/plantuml-server