Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitjourney/plantuml-service
High-performance HTTP service for PlantUML, used in Kibela
https://github.com/bitjourney/plantuml-service
kibela plantuml uml web-api
Last synced: 3 months ago
JSON representation
High-performance HTTP service for PlantUML, used in Kibela
- Host: GitHub
- URL: https://github.com/bitjourney/plantuml-service
- Owner: bitjourney
- License: other
- Created: 2016-08-06T09:18:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T05:33:47.000Z (7 months ago)
- Last Synced: 2024-04-02T05:43:34.976Z (7 months ago)
- Topics: kibela, plantuml, uml, web-api
- Language: Kotlin
- Homepage:
- Size: 429 KB
- Stars: 99
- Watchers: 12
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PlantUML HTTP service [](https://travis-ci.org/bitjourney/plantuml-service)
This is a high-performance HTTP interface to [PlantUML](http://plantuml.com/).
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Install](#install)
- [Jar](#jar)
- [Docker](#docker)
- [Usage](#usage)
- [`POST /svg` where `body` is the source of PlantUML](#post-svg-where-body-is-the-source-of-plantuml)
- [`GET /svg/:source`](#get-svgsource)
- [`GET /version`](#get-version)
- [Development](#development)
- [Deployment](#deployment)
- [Run with systemd](#run-with-systemd)
- [Release Engineering](#release-engineering)
- [See Also](#see-also)
- [Authors](#authors)
- [License](#license)
## Install
There's two way to install plantuml-service:
### Jar
Get `plantuml-service.jar` from [GitHub releases](https://github.com/bitjourney/plantuml-service/releases).
### Docker
There is a docker image in [GitHub Container Registry](https://github.com/orgs/bitjourney/packages/container/package/plantuml-service).
```sh
docker pull ghcr.io/bitjourney/plantuml-service:1.4.11
```
## Usage
### `POST /svg` where `body` is the source of PlantUML
Returns an SVG image of the request body, processed by PlantUML.
Because the size of GET requests might be limited by middlewares, the POST API is recommended in production.
### `GET /svg/:source`
Returns an SVG image of `:source` processed by PlantUML.
`:source` is source code of PlantUML, encoded in [percent encoding](https://en.wikipedia.org/wiki/Percent-encoding).
Example:
Given a PlantUML source code:
```plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
```
To show it in SVG:
```markdown
```
Then, you'll get:
This path takes multiple `config` parameters to set configuration, for example:
`/svg/...?config=scale max 1024 width&config=skin BlueModern`
NOTE: you should use server-side RPC to render SVG because browsers have URL limitations.
### `GET /version`
Shows the version of PlantUML and plantuml-service in JSON:
```json
{"PlantUML":"2017.11","plantuml-service":"1.0.9"}
```
This is also intended to check the service helth.
## Development
Run on local:
```sh
./gradlew stage
```
## Deployment
### Run with systemd
Here is an example systemd.service(5) config file:
```ini
[Unit]
Descrption=PlantUML service
Documentation=https://github.com/bitjourney/plantuml-service
Wants=network-online.target
After=network-online.target
[Service]
ExecStart=$APP_PATH/app/bin/plantuml-service
WorkingDirectory=$APP_PATH/app
User=$APP_USER
Group=$APP_USER
[Install]
WantedBy=multi-user.target
```
## Release Engineering
1. Create the credential file by `echo "oauth=$GITHUB_ACCESS_TOKEN" > ~/.github`
2. Update the version of `build.gradle`
3. Run `./gradlew release`
- It uploads artifacts to GitHub
- And then build the docker image and push the image to Docker Hub
## See Also
* http://plantuml.com/
* https://github.com/plantuml/plantuml
* https://github.com/plantuml/plantuml-server
## Authors
* FUJI Goro ([gfx](https://github.com/gfx))
## License
Copyright (c) 2016 Bit Journey, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.