{"id":13603135,"url":"https://github.com/zeromicro/goctl-swagger","last_synced_at":"2025-05-15T17:05:48.027Z","repository":{"id":36968626,"uuid":"325974386","full_name":"zeromicro/goctl-swagger","owner":"zeromicro","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-06T10:17:38.000Z","size":7287,"stargazers_count":225,"open_issues_count":54,"forks_count":143,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-11T23:57:22.605Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/zeromicro.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":"2021-01-01T12:25:39.000Z","updated_at":"2025-03-27T04:22:44.000Z","dependencies_parsed_at":"2024-06-18T19:35:50.792Z","dependency_job_id":"47ca0cd9-0012-4c2f-ab77-43d58430e6ab","html_url":"https://github.com/zeromicro/goctl-swagger","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromicro%2Fgoctl-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromicro%2Fgoctl-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromicro%2Fgoctl-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromicro%2Fgoctl-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeromicro","download_url":"https://codeload.github.com/zeromicro/goctl-swagger/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254384988,"owners_count":22062422,"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-08-01T18:01:52.745Z","updated_at":"2025-05-15T17:05:43.015Z","avatar_url":"https://github.com/zeromicro.png","language":"PHP","funding_links":[],"categories":["PHP","Tools and plugins for [go-zero](https://github.com/tal-tech/go-zero)"],"sub_categories":[],"readme":"# goctl-swagger\n\n### 1. 编译goctl-swagger插件\n\n```\nGOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/goctl-swagger@latest\n```\n\n### 2. 配置环境\n\n将$GOPATH/bin中的goctl-swagger添加到环境变量\n\n### 3. 使用姿势\n\n* 创建api文件\n\n    ```go\n    info(\n     title: \"type title here\"\n     desc: \"type desc here\"\n     author: \"type author here\"\n     email: \"type email here\"\n     version: \"type version here\"\n    )\n    \n    \n    type (\n     RegisterReq {\n      Username string `json:\"username\"`\n      Password string `json:\"password\"`\n      Mobile string `json:\"mobile\"`\n     }\n     \n     LoginReq {\n      Username string `json:\"username\"`\n      Password string `json:\"password\"`\n     }\n     \n     UserInfoReq {\n      Id string `path:\"id\"`\n     }\n     \n     UserInfoReply {\n      Name string `json:\"name\"`\n      Age int `json:\"age\"`\n      Birthday string `json:\"birthday\"`\n      Description string `json:\"description\"`\n      Tag []string `json:\"tag\"`\n     }\n     \n     UserSearchReq {\n      KeyWord string `form:\"keyWord\"`\n     }\n    )\n    \n    service user-api {\n     @doc(\n      summary: \"注册\"\n     )\n     @handler register\n     post /api/user/register (RegisterReq)\n     \n     @doc(\n      summary: \"登录\"\n     )\n     @handler login\n     post /api/user/login (LoginReq)\n     \n     @doc(\n      summary: \"获取用户信息\"\n     )\n     @handler getUserInfo\n     get /api/user/:id (UserInfoReq) returns (UserInfoReply)\n     \n     @doc(\n      summary: \"用户搜索\"\n     )\n     @handler searchUser\n     get /api/user/search (UserSearchReq) returns (UserInfoReply)\n    }\n    ```\n\n* 生成swagger.json 文件\n\n    ```shell script\n    goctl api plugin -plugin goctl-swagger=\"swagger -filename user.json\" -api user.api -dir .\n    ```\n\n* 指定Host，basePath，schemes [api-host-and-base-path](https://swagger.io/docs/specification/2-0/api-host-and-base-path/)\n\n    ```shell script\n    goctl api plugin -plugin goctl-swagger=\"swagger -filename user.json -host 127.0.0.2 -basepath /api -schemes https,wss\" -api user.api -dir .\n    ```\n\n* swagger ui 查看生成的文档\n\n    ```shell script\n     docker run --rm -p 8083:8080 -e SWAGGER_JSON=/foo/user.json -v $PWD:/foo swaggerapi/swagger-ui\n   ```\n\n* Swagger Codegen 生成客户端调用代码(go,javascript,php)\n\n  ```shell script\n  for l in go javascript php; do\n    docker run --rm -v \"$(pwd):/go-work\" swaggerapi/swagger-codegen-cli generate \\\n      -i \"/go-work/rest.swagger.json\" \\\n      -l \"$l\" \\\n      -o \"/go-work/clients/$l\"\n  done\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeromicro%2Fgoctl-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeromicro%2Fgoctl-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeromicro%2Fgoctl-swagger/lists"}