{"id":18352937,"url":"https://github.com/aaronhuggins/typedoc-plugin-openapi-doc","last_synced_at":"2026-04-28T09:34:33.145Z","repository":{"id":52276689,"uuid":"336290701","full_name":"aaronhuggins/typedoc-plugin-openapi-doc","owner":"aaronhuggins","description":"A typedoc plugin for ingesting jsdoc `@swagger` or `@openapi` comments as documentation.","archived":false,"fork":false,"pushed_at":"2021-02-09T19:52:00.000Z","size":211,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-27T12:05:28.378Z","etag":null,"topics":["openapi","swagger","typedoc","typedoc-plugin","typedocplugin"],"latest_commit_sha":null,"homepage":"https://ahuggins-nhs.github.io/typedoc-plugin-openapi-doc/","language":"TypeScript","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/aaronhuggins.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":"2021-02-05T14:12:31.000Z","updated_at":"2024-04-12T11:36:10.000Z","dependencies_parsed_at":"2022-09-18T10:50:14.485Z","dependency_job_id":null,"html_url":"https://github.com/aaronhuggins/typedoc-plugin-openapi-doc","commit_stats":null,"previous_names":["ahuggins-nhs/typedoc-plugin-openapi-doc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aaronhuggins/typedoc-plugin-openapi-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronhuggins%2Ftypedoc-plugin-openapi-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronhuggins%2Ftypedoc-plugin-openapi-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronhuggins%2Ftypedoc-plugin-openapi-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronhuggins%2Ftypedoc-plugin-openapi-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aaronhuggins","download_url":"https://codeload.github.com/aaronhuggins/typedoc-plugin-openapi-doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronhuggins%2Ftypedoc-plugin-openapi-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32375611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T09:24:15.638Z","status":"ssl_error","status_checked_at":"2026-04-28T09:24:15.071Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["openapi","swagger","typedoc","typedoc-plugin","typedocplugin"],"created_at":"2024-11-05T21:37:59.085Z","updated_at":"2026-04-28T09:34:33.104Z","avatar_url":"https://github.com/aaronhuggins.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedoc-plugin-openapi-doc\n\nA typedoc plugin for ingesting jsdoc @swagger or @openapi comments as documentation.\n\n# Installation and use\n\nInstall via npm; requires a peer of TypeDoc 0.20.20 or above.\n\n```shell\nnpm install --save-dev typedoc typedoc-plugin-openapi-doc\n```\n\nThis plugin automatically detects the typedoc plugin for [markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown) and will skip generating CSS styles for collapsible content.\n\n# TypeDoc options\n\nThe following options may be defined in a typedoc config. However, all of the options default to true and it is not required that they are provided.\n\n```json\n  \"openapi-doc\": {\n    \"hoistDescription\": true,\n    \"yaml2Html\": false,\n    \"renameTag\": \"MyNewTagName\"\n  }\n```\n\n# Why\n\nThe rendering of `@swagger` JSDoc tags was ugly to the point of being useless in TypeDoc, which meant ignoring these tags. Additionally, such a comment tag often included additional information that would have to be repeated when writing description documentation for TypeDoc to consume.\n\nThe result is this plugin, to reduce copypasta of descriptive information and to render OpenAPI metadata in a more human-readable way.\n\n# Other tools which ingest @swagger/@openapi comments\n\n- [Project to OpenAPI](https://github.com/ahuggins-nhs/project-to-openapi) uses `@swagger` comments.\n- [Swagger JSDoc](https://github.com/Surnet/swagger-jsdoc) uses `@swagger` for its notation.\n- [OpenAPI JSDoc](https://github.com/asznee7/openapi-jsdoc) uses `@openapi`.\n\n# Code documentation\n\nFound [here](https://ahuggins-nhs.github.io/typedoc-plugin-openapi-doc/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronhuggins%2Ftypedoc-plugin-openapi-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faaronhuggins%2Ftypedoc-plugin-openapi-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronhuggins%2Ftypedoc-plugin-openapi-doc/lists"}