GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → nlohmann → Swagger_to_uml

nlohmann / Swagger_to_uml

Licence: mit
Convert OpenAPI specifications (a.k.a. Swagger) to PlantUML diagrams

Programming Languages

python
139335 projects - #7 most used programming language

Labels

swaggeropenapiplantumlswagger2

Projects that are alternatives of or similar to Swagger to uml

Swag
Automatically generate RESTful API documentation with Swagger 2.0 for Go.
Stars: ✭ 5,173 (+3492.36%)
Mutual labels:  swagger, openapi, swagger2
Angular Swagger Ui
An angularJS implementation of Swagger UI
Stars: ✭ 131 (-9.03%)
Mutual labels:  swagger, openapi, swagger2
Openapi.tools
A collection of Editors, Linters, Parsers, Code Generators, Documentation, Testing
Stars: ✭ 257 (+78.47%)
Mutual labels:  swagger, openapi, swagger2
Restful React
A consistent, declarative way of interacting with RESTful backends, featuring code-generation from Swagger and OpenAPI specs 🔥
Stars: ✭ 1,814 (+1159.72%)
Mutual labels:  swagger, openapi
Ssm
👅基于RESTful风格的前后端分离的SSM框架，集成了shiro和swagger等框架
Stars: ✭ 141 (-2.08%)
Mutual labels:  swagger, swagger2
Gemini
Model Driven REST framework to automatically generate CRUD APIs
Stars: ✭ 138 (-4.17%)
Mutual labels:  swagger, openapi
Netcoreblockly
.NET Core API to Blockly - generate from WebAPI, Swagger, OData, GraphQL =>
Stars: ✭ 121 (-15.97%)
Mutual labels:  swagger, openapi
Mentorship Backend
Mentorship System is an application that matches women in tech to mentor each other, on career development, through 1:1 relations during a certain period of time. This is the backend of this system.
Stars: ✭ 132 (-8.33%)
Mutual labels:  swagger, openapi
Grpc Gateway
The gRPC-Gateway is a plugin of the Google protocol buffers compiler protoc. It reads protobuf service definitions and generates a reverse-proxy server which translates a RESTful HTTP API into gRPC. This server is generated according to the google.api.http annotations in your service definitions.
Stars: ✭ 12,223 (+8388.19%)
Mutual labels:  swagger, openapi
Prance
Resolving Swagger/OpenAPI 2.0 and 3.0 Parser
Stars: ✭ 133 (-7.64%)
Mutual labels:  swagger, openapi
Laravel Swagger
Auto generates the swagger documentation of a laravel project based on best practices and simple assumptions
Stars: ✭ 129 (-10.42%)
Mutual labels:  swagger, swagger2
Terraform Provider Openapi
OpenAPI Terraform Provider that configures itself at runtime with the resources exposed by the service provider (defined in a swagger file)
Stars: ✭ 134 (-6.94%)
Mutual labels:  swagger, openapi
Rapipdf
PDF generation from OpenAPI / Swagger Spec
Stars: ✭ 132 (-8.33%)
Mutual labels:  swagger, openapi
Http Router
🎉 Release 2.0 is released! Very fast HTTP router for PHP 7.1+ (incl. PHP8 with attributes) based on PSR-7 and PSR-15 with support for annotations and OpenApi (Swagger)
Stars: ✭ 124 (-13.89%)
Mutual labels:  swagger, openapi
Graphql Mesh
GraphQL Mesh — Query anything, run anywhere
Stars: ✭ 2,114 (+1368.06%)
Mutual labels:  swagger, openapi
Wizard
Wizard是一款开源的文档管理工具，支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+1103.47%)
Mutual labels:  swagger, openapi
Vs Swagger Viewer
Swagger Viewer lets you preview and validate Swagger 2.0 and OpenAPI files as you type in Visual Studio Code.
Stars: ✭ 126 (-12.5%)
Mutual labels:  swagger, openapi
Swagger Axios Codegen
swagger client to use axios and typescript
Stars: ✭ 143 (-0.69%)
Mutual labels:  swagger, openapi
L5 Swagger
OpenApi or Swagger integration to Laravel
Stars: ✭ 1,781 (+1136.81%)
Mutual labels:  swagger, openapi
Openapi Core
OpenAPI core
Stars: ✭ 119 (-17.36%)
Mutual labels:  swagger, openapi
View All Similar Projects ➔

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].