{"id":41267730,"url":"https://github.com/zc2638/apidoc","last_synced_at":"2026-01-23T02:14:51.508Z","repository":{"id":57703474,"uuid":"495836772","full_name":"zc2638/apidoc","owner":"zc2638","description":"This is a tool and Golang package that uses swagger2.0 definitions to generate API static documents (such as pdf) .","archived":false,"fork":false,"pushed_at":"2022-08-10T08:02:37.000Z","size":37,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-06-19T16:46:04.988Z","etag":null,"topics":["apidoc","document","swagger"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zc2638.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":"2022-05-24T13:31:51.000Z","updated_at":"2022-09-19T10:01:05.000Z","dependencies_parsed_at":"2022-09-14T22:40:13.331Z","dependency_job_id":null,"html_url":"https://github.com/zc2638/apidoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zc2638/apidoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zc2638%2Fapidoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zc2638%2Fapidoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zc2638%2Fapidoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zc2638%2Fapidoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zc2638","download_url":"https://codeload.github.com/zc2638/apidoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zc2638%2Fapidoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28677725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T01:00:35.747Z","status":"online","status_checked_at":"2026-01-23T02:00:08.296Z","response_time":59,"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":["apidoc","document","swagger"],"created_at":"2026-01-23T02:14:50.439Z","updated_at":"2026-01-23T02:14:51.486Z","avatar_url":"https://github.com/zc2638.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apidoc\n\n![LICENSE](https://img.shields.io/github/license/zc2638/apidoc.svg?style=flat-square\u0026color=blue)\n[![GoDoc](https://pkg.go.dev/badge/github.com/zc2638/apidoc)](https://pkg.go.dev/github.com/zc2638/apidoc)\n[![Go Report Card](https://goreportcard.com/badge/github.com/zc2638/apidoc?style=flat-square)](https://goreportcard.com/report/github.com/zc2638/apidoc)\n\nEnglish | [简体中文](./README_zh.md)\n\nThis is a tool and `Golang` package that uses `swagger2.0` definitions to generate API static documents (such as pdf)\nbased\non template files.\n\n## Installation\n\n### 1、Source Code\n\n#### Preconditions\n\nThe `wkhtmltopdf` package must be installed.\n\n- MacOS: `brew install Caskroom/cask/wkhtmltopdf`\n- multiple operating systems can be found\n  at [https://wkhtmltopdf.org/downloads.html](https://wkhtmltopdf.org/downloads.html).\n\n#### Install Command\n\n```shell\ngo install github.com/zc2638/apidoc/cmd/apidoc@latest\n```\n\n### 2、Docker\n\n```shell\ndocker pull zc2638/apidoc:latest\n```\n\n## Use In Docker\n\n```shell\ndocker run --rm zc2638/apidoc:latest --src https://petstore.swagger.io/v2/swagger.json --data \u003e petstore.pdf\n```\n\n## Use In Command\n\n### From File\n\n```shell\napidoc --src \u003cyour-swagger-json\u003e [--dest \u003cyour-output-dir\u003e]\n```\n\n### From URL\n\n```shell\napidoc --src https://petstore.swagger.io/v2/swagger.json\n```\n\n## Toolkit Example\n\nPlease visit the [example](./example/main.go)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzc2638%2Fapidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzc2638%2Fapidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzc2638%2Fapidoc/lists"}