{"id":18438702,"url":"https://github.com/seapagan/openapi-readme","last_synced_at":"2025-10-06T01:44:36.834Z","repository":{"id":61810325,"uuid":"555384127","full_name":"seapagan/openapi-readme","owner":"seapagan","description":"Generate Markdown from an OpenAPI JSON spec file.","archived":false,"fork":false,"pushed_at":"2025-09-22T17:10:50.000Z","size":246,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-29T02:22:20.225Z","etag":null,"topics":["markdown","openapi-documentation"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/openapi-readme/","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/seapagan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-10-21T13:25:55.000Z","updated_at":"2024-11-05T09:37:45.000Z","dependencies_parsed_at":"2024-06-10T14:34:30.961Z","dependency_job_id":"3447b1f6-1481-4ab3-a4f3-8ab90718f8ab","html_url":"https://github.com/seapagan/openapi-readme","commit_stats":{"total_commits":29,"total_committers":3,"mean_commits":9.666666666666666,"dds":0.2068965517241379,"last_synced_commit":"24c7e89ad8196968c86dc377c2ec585b0d92838f"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/seapagan/openapi-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fopenapi-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fopenapi-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fopenapi-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fopenapi-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seapagan","download_url":"https://codeload.github.com/seapagan/openapi-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fopenapi-readme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278547876,"owners_count":26004773,"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","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["markdown","openapi-documentation"],"created_at":"2024-11-06T06:21:17.511Z","updated_at":"2025-10-06T01:44:36.820Z","avatar_url":"https://github.com/seapagan.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Readme Generator  \u003c!-- omit in toc --\u003e\n\nGenerates Markdown suitable for a README file from a local `openapi.json` file.\n\nI still plan to add more features to this tool, but it is already useful for\ngenerating basic API documentation in Markdown from an OpenAPI schema.\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Options Summary](#options-summary)\n- [Options in Detail](#options-in-detail)\n  - [--route-level](#--route-level)\n  - [--inject](#--inject)\n- [TODO](#todo)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nThis tool can be installed via `uv`, `poetry` or `pip` depending on your needs:\n\nThis tool is usually only needed during development, so it is recommended to\ninstall it as a development dependency.\n\nuv:\n\n```console\nuv add --dev openapi-readme\n```\n\nPoetry:\n\n```console\npoetry add openapi-readme --group dev\n```\n\nOr Pip:\n\n```console\npip install openapi-readme\n```\n\nThis will install the `openapi-readme` command line tool.\n\n## Usage\n\n```console\nopenapi-readme [OPTIONS]\n```\n\nRun this in the same directory as your `openapi.json` file. By default the\nMarkdown output will be printed to the console, but you can redirect it out to\na file too.\n\nThe particular styling of the generated Markdown is currently hardcoded, though\nplans are afoot to implement some sort of themeing.\n\n## Options Summary\n\n- `--route-level INTEGER`: Number of heading levels to use.  [default: 4]\n- `--inject / --no-inject`: Inject generated output into a README file.\n  [default: False]\n- `--help`: Show this message and exit.\n\n## Options in Detail\n\n### --route-level\n\nSpecify the heading level for each Route in the generated documentation. This\ndefaults to **4** if not specified, ie:\n\n```Markdown\n#### **`GET`** _/user/list_\n```\n\n### --inject\n\nInjects the new Markdown directly into a `README.md` file in the current\ndirectory, if it is found.\nYou need to add the placeholder comment `\u003c!--\nopenapi-schema --\u003e` to your markdown where you want it to be injected:\n\n```Markdown\nThis is some preceeding text\n\n### API Schema description\n\u003c!-- openapi-schema --\u003e\n\n### Next section\nThe document continues unaffected after the injection.\n```\n\nExisting (previously injected) Schemas will be **replaced** by this new data.\n\n## TODO\n\nFuture improvement plans\n\n- Take more info from the `openapi.json` file\n\n## Contributing\n\nAll PRs to add features of fix bugs are very welcome!\n\nPlease read the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and\n[CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the\nprocess for submitting pull requests to us.\n\n## License\n\nThis project is licensed under the MIT License as reproduced below:\n\n```pre\n    Copyright (c) 2022-2024 Grant Ramsay\n\n    Permission is hereby granted, free of charge, to any person obtaining a copy\n    of this software and associated documentation files (the \"Software\"), to deal\n    in the Software without restriction, including without limitation the rights\n    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n    copies of the Software, and to permit persons to whom the Software is\n    furnished to do so, subject to the following conditions:\n\n    The above copyright notice and this permission notice shall be included in all\n    copies or substantial portions of the Software.\n\n    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n    SOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseapagan%2Fopenapi-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseapagan%2Fopenapi-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseapagan%2Fopenapi-readme/lists"}