Convert OpenAPI specifications (a.k.a. Swagger) to PlantUML diagrams
Switch branches/tags
Nothing to show
Clone or download
nlohmann Merge pull request #4 from phfeustel/feature/in_case_of_missing_types…
…_dump_dict_for_easier_analysis

In case of missing type attribute dump dict to stderr for easier anal…
Latest commit a509cfe May 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
petstore_example
.gitignore
LICENSE 📄 added license Nov 20, 2017
README.md fixes: update README.md Dec 18, 2017
requirements.txt added PyYAML as requirement Jan 16, 2018
swagger_to_uml.py Rework review comments. May 19, 2018

README.md

Swagger to UML

A small pure Python script that converts OpenAPI specifications (a.k.a. Swagger) into Plant UML diagrams. The goal is not to replace existing documentation generators, but to complement them with a visual representation of the routes, models, and their relationships.

Example

excerpt of the petstore example

To create a diagram from the petstore example, call the script with:

python swagger_to_uml.py petstore_example/swagger.json >petstore_example/swagger.puml

It will create the file petstore_example/swagger.puml which can then be translated into a PNG image with PlantUML with:

plantuml petstore_example/swagger.puml -tpng

Note you need to install Plant UML and Graphviz for this.

Installation

The script runs with Python 3 without any additional packages. Transforming PUML into vector graphics or other requires external tools however.

On macOS, the installation of the required tools with Homebrew is simple:

brew install plantuml graphviz

Contribute

The script is just a first proof-of-concept version. Issues and pull requests welcome!

Copyright

MIT License

Copyright (c) 2017 Niels Lohmann http://nlohmann.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.