{"id":13422729,"url":"https://github.com/nlohmann/swagger_to_uml","last_synced_at":"2025-04-07T13:08:49.996Z","repository":{"id":46669001,"uuid":"111465824","full_name":"nlohmann/swagger_to_uml","owner":"nlohmann","description":"Convert OpenAPI specifications (a.k.a. Swagger) to PlantUML diagrams","archived":false,"fork":false,"pushed_at":"2021-10-01T03:52:41.000Z","size":120,"stargazers_count":257,"open_issues_count":16,"forks_count":68,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-31T12:05:06.835Z","etag":null,"topics":["openapi","plantuml","plantuml-diagrams","plantuml-generator","swagger","swagger-docs","swagger2"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nlohmann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-20T21:41:04.000Z","updated_at":"2025-03-30T21:19:29.000Z","dependencies_parsed_at":"2022-08-12T13:00:49.209Z","dependency_job_id":null,"html_url":"https://github.com/nlohmann/swagger_to_uml","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlohmann%2Fswagger_to_uml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlohmann%2Fswagger_to_uml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlohmann%2Fswagger_to_uml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlohmann%2Fswagger_to_uml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nlohmann","download_url":"https://codeload.github.com/nlohmann/swagger_to_uml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657281,"owners_count":20974345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","plantuml","plantuml-diagrams","plantuml-generator","swagger","swagger-docs","swagger2"],"created_at":"2024-07-30T23:00:51.883Z","updated_at":"2025-04-07T13:08:49.950Z","avatar_url":"https://github.com/nlohmann.png","language":"Python","funding_links":[],"categories":["Tools \u0026\u0026 Specifications","Python"],"sub_categories":["GraphQL"],"readme":"# Swagger to UML\n\nA small pure Python script that converts [OpenAPI specifications](https://www.openapis.org) (a.k.a. [Swagger](https://swagger.io)) into [Plant UML](http://plantuml.com) 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.\n\n## Example\n\n![excerpt of the petstore example](petstore_example/swagger.png)\n\nTo create a diagram from the [petstore example](http://petstore.swagger.io), call the script with:\n\n```\npython swagger_to_uml.py petstore_example/swagger.json \u003epetstore_example/swagger.puml\n```\n\nIt will create the file `petstore_example/swagger.puml` which can then be translated into a PNG image with PlantUML with:\n\n```\nplantuml petstore_example/swagger.puml -tpng\n```\n\nNote you need to install [Plant UML](http://plantuml.com) and [Graphviz](http://www.graphviz.org) for this.\n\n## Installation\n\nThe script runs with Python 3 without any additional packages. Transforming PUML into vector graphics or other requires external tools however.\n\nOn macOS, the installation of the required tools with [Homebrew](https://brew.sh) is simple:\n\n```\nbrew install plantuml graphviz\n```\n\n## Contribute\n\nThe script is just a first proof-of-concept version. Issues and pull requests welcome!\n\n## Copyright\n\nMIT License\n\nCopyright (c) 2017 Niels Lohmann \u003chttp://nlohmann.me\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnlohmann%2Fswagger_to_uml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnlohmann%2Fswagger_to_uml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnlohmann%2Fswagger_to_uml/lists"}