{"id":26555579,"url":"https://github.com/lornajane/apitapviz","last_synced_at":"2026-05-09T17:47:09.453Z","repository":{"id":282061392,"uuid":"943409257","full_name":"lornajane/apitapviz","owner":"lornajane","description":"Simple visualisation of OpenAPI Arazzo files as Markdown or mermaidjs. (Mirror of the main apitapviz repo)","archived":false,"fork":false,"pushed_at":"2025-03-12T15:09:02.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T16:24:01.261Z","etag":null,"topics":["arazzo","cli","openapi","vizualisation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"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/lornajane.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-05T16:57:57.000Z","updated_at":"2025-03-12T15:09:05.000Z","dependencies_parsed_at":"2025-03-12T16:24:04.732Z","dependency_job_id":"8d11c015-03f4-4eaf-b3c6-29ca44b6853a","html_url":"https://github.com/lornajane/apitapviz","commit_stats":null,"previous_names":["lornajane/apitapviz"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lornajane%2Fapitapviz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lornajane%2Fapitapviz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lornajane%2Fapitapviz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lornajane%2Fapitapviz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lornajane","download_url":"https://codeload.github.com/lornajane/apitapviz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244945597,"owners_count":20536297,"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":["arazzo","cli","openapi","vizualisation"],"created_at":"2025-03-22T10:54:00.105Z","updated_at":"2026-05-09T17:47:04.403Z","avatar_url":"https://github.com/lornajane.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ApiTapViz\n\nThis is a command line tool to produce a human-readable representation of an [OpenAPI Arazzo](https://www.openapis.org/arazzo) file.\nOutput is available in [Markdown](https://daringfireball.net/projects/markdown/) or [Mermaid](https://mermaid.js.org/) format.\n\nUse this tool to create a representation for summary purposes during development, or to include in your own documentation.\n\n:warning: This tool is at an alpha stage.\nPull requests are welcome, but you'd be an early adopter if you use it now - you have been warned!\n\nFeedback and feature requests are welcome on the main project repo (note: not the GitHub mirror!): \u003chttps://codeberg.org/lornajane/apitapviz\u003e\n\n## Installation\n\nThis is a Python project, using [uv](https://github.com/astral-sh/uv).\n\n1. Clone the repository to your machine.\n\n2. Run `uv sync`.\n\n3. Run the command with an Arazzo file:\n\n   ```bash\n   uv run main.py arazzo.yaml\n   ```\n\n## Usage\n\nCommand format: `main.py [-h] [--format FORMAT] arazzo.yaml`\n\n* `-h` for the help output.\n* `--format` can be `markdown` or `mermaid`.\n* Supply a valid OpenAPI Arazzo file in YAML format.\n\n## Example output\n\nCurrently the tool supports Mermaid and Markdown format outputs.\n\n### Markdown example\n\nThe markdown output lists each step with some supporting data.\n\n```markdown\n## Blog workflows\n\n### 1: getCategories\n\nFetch the category list\n\n- Operation: `$sourceDescriptions.blog.getCategories`\n- Outputs: category_id\n\n### 2: savePost\n\nCreate the blog post\n\n- Operation: `$sourceDescriptions.blog.createPost`\n- Outputs: post_id\n\n### 3: addImage\n\nUpload the image\n\n- Operation: `$sourceDescriptions.blog.uploadFeaturedImage`\n\n```\n\n### Mermaid example\n\nThe Mermaid diagram shows summary information for each flow; both the source and result are shown below:\n\n```text\n---\ntitle: Blog workflows\n---\ngraph TD\nget_categories[\"getCategories\"]\nsave_post[\"savePost\"]\nadd_image[\"addImage\"]\nget_categories ---\u003e save_post\nsave_post ---\u003e add_image\n```\n```mermaid\n---\ntitle: Blog workflows\n---\ngraph TD\nget_categories[\"getCategories\"]\nsave_post[\"savePost\"]\nadd_image[\"addImage\"]\nget_categories ---\u003e save_post\nsave_post ---\u003e add_image\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flornajane%2Fapitapviz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flornajane%2Fapitapviz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flornajane%2Fapitapviz/lists"}