{"id":18309387,"url":"https://github.com/masterjoyhunan/genshowdoc","last_synced_at":"2025-07-13T03:37:48.548Z","repository":{"id":57709559,"uuid":"508961720","full_name":"MasterJoyHunan/genshowdoc","owner":"MasterJoyHunan","description":"go-zero api 文件转换为 show doc 文档","archived":false,"fork":false,"pushed_at":"2022-07-01T07:37:34.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-15T05:30:23.797Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/MasterJoyHunan.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-06-30T06:34:22.000Z","updated_at":"2022-07-01T07:36:37.000Z","dependencies_parsed_at":"2022-09-26T21:21:09.707Z","dependency_job_id":null,"html_url":"https://github.com/MasterJoyHunan/genshowdoc","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MasterJoyHunan%2Fgenshowdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MasterJoyHunan%2Fgenshowdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MasterJoyHunan%2Fgenshowdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MasterJoyHunan%2Fgenshowdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MasterJoyHunan","download_url":"https://codeload.github.com/MasterJoyHunan/genshowdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248032934,"owners_count":21036697,"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":[],"created_at":"2024-11-05T16:11:17.333Z","updated_at":"2025-04-09T11:40:29.365Z","avatar_url":"https://github.com/MasterJoyHunan.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## genshowdoc 一个生成 showdoc 文档的工具\n\ngenshowdoc 基于 go-zero 开发，根据定义的 .api 文件，一行命令就可以生成 showdoc 文档\n\n#### 安装\n\ngo 1.16 以下使用\n```sh\ngo get -u github.com/MasterJoyHunan/genshowdoc\n```\ngo 1.16 及以上使用\n```sh\ngo install github.com/MasterJoyHunan/genshowdoc@v1.0.1\n```\n\n#### 在项目下定义 you-app.api 文件\n\n[api语法指南](https://go-zero.dev/cn/docs/design/grammar)\n\nyou-app.api 文件内容示例\n\n```api\nsyntax = \"v1\"\n\ninfo(\n\ttitle: \"some app\"\n)\n\ntype bookRequest {\n    Name string `json:\"name\"` // 姓名\n    Age int `json:\"age\"`      // 年龄\n}\n\ntype bookResponse {\n    Code int `json:\"code\"` // 业务码\n    Msg string `json:\"msg\"` // 业务消息\n}\n\n@server(\n    jwt: Auth\n    group: book\n    middleware: SomeMiddleware,CorsMiddleware\n    prefix: /v1\n)\n\nservice someapp {\n    @doc \"获取所有书本信息\"\n    @handler getBookList\n    get /book (bookRequest) returns (bookResponse)\n\n    @doc \"获取书本信息\"\n    @handler getBook\n    get /book/:id (bookRequest) returns (bookResponse)\n\n    @doc \"添加书本信息\"\n    @handler addBook\n    post /book (bookRequest) returns (bookResponse)\n\n    @doc \"获取书本信息\"\n    @handler editBook\n    put /book/:id (bookRequest) returns (bookResponse)\n}\n```\n\n#### 生成文档\n\n```sh\ngenshowdoc --api=\"http://host:port/server/index.php?s=/api/item/updateByApi\" --key=\"you_key\" --token=\"you_token\" xxx.api\n```\n\n参数描述\n\n* `--api` api 请求地址\n* `--key` 项目的 key\n* `--token` 项目的 token\n\n### 其他\n\n如果觉得该项目对你有所帮助，请不要吝啬你的小手，帮忙点个 stars\n\n如果对本项目有更好的建议或意见，欢迎提交 pr / issues，或者联系本人 tanwuyang88@gmail.com\n\n再次感谢 [go-zero](https://github.com/zeromicro/go-zero)\n\n### 协议\n\n[MIT](https://github.com/MasterJoyHunan/genshowdoc/blob/master/LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmasterjoyhunan%2Fgenshowdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmasterjoyhunan%2Fgenshowdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmasterjoyhunan%2Fgenshowdoc/lists"}