{"id":18470827,"url":"https://github.com/nefe/vscode-swag","last_synced_at":"2025-09-10T05:35:01.425Z","repository":{"id":95807395,"uuid":"132458308","full_name":"nefe/vscode-swag","owner":"nefe","description":null,"archived":false,"fork":false,"pushed_at":"2018-05-23T06:08:04.000Z","size":85,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-12T14:04:45.074Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nefe.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2018-05-07T12:36:33.000Z","updated_at":"2018-05-23T06:08:04.000Z","dependencies_parsed_at":"2023-03-03T03:00:22.054Z","dependency_job_id":null,"html_url":"https://github.com/nefe/vscode-swag","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nefe/vscode-swag","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nefe%2Fvscode-swag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nefe%2Fvscode-swag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nefe%2Fvscode-swag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nefe%2Fvscode-swag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nefe","download_url":"https://codeload.github.com/nefe/vscode-swag/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nefe%2Fvscode-swag/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274417321,"owners_count":25281108,"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-09-10T02:00:12.551Z","response_time":83,"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":[],"created_at":"2024-11-06T10:14:57.824Z","updated_at":"2025-09-10T05:35:01.404Z","avatar_url":"https://github.com/nefe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swag README\n\n一、安装\n\n1、打开 vscode。扩展中搜索 swag。安装并点击重新加载。\n\n2、项目中要包含 swag-config.json 。配置如下：\n\n```json\n{\n  // 配置代码模板\n  \"templatePath\": \"./swagTemplate\",\n  \"outDir\": \"../src/services\",\n  \"originUrl\": \"http://your-service-hostname/v2/api-docs\",\n  // 配置代码风格\n  \"prettierConfig\": {\n    \"printWidth\": 120,\n    \"singleQuote\": true,\n    \"trailingComma\": \"none\",\n    \"jsxBracketSameLine\": true\n  }\n}\n```\n\n代码模板：swagTemplate.ts\n\n```typescript\nimport { Template } from \"swag-engine\";\n\nmodule.exports = {\n  // 类型代码\n  header(inter) {\n    return `\n    export ${inter.paramsType.replace(\"lock: number\", \"lock?: number\")}\n    \n    export type Response = ${inter.responseType}\n\n    export const init: Response;\n\n    export function request(params${inter.bodyParams ? \"\" : \"?\"}: Params${\n      inter.bodyParams ? `, bodyParams: ${inter.bodyParams}` : \"\"\n    }): Promise\u003cResponse\u003e;\n\n    export function createFetchAction\u003cKey\u003e(types: FetchTypes\u003cKey\u003e): (params${\n      inter.bodyParams ? \"\" : \"?\"\n    }: Params${\n      inter.bodyParams ? `, bodyParams: ${inter.bodyParams}` : \"\"\n    }, meta?)\n      =\u003e { type: Key; payload?: Response; params?: Params; url: string; types: string[] } \u0026 Promise\u003cResponse\u003e\n      `;\n  },\n\n  // 公共代码\n  commonHeader() {\n    return `\n    interface FetchTypes\u003ckey\u003e {\n\t\t\terror: 'error',\n\t\t\tsuccess: key,\n\t\t\tloading: 'loading',\n\t\t};\n\n\t\tinterface FetchAction\u003cBO, key\u003e {\n\t\t\ttype: key,\n\t\t\tpayload: BO,\n    }\n    `;\n  },\n\n  // 实现代码\n  implement(inter) {\n    return `\n    /**\n     * @description ${inter.description}\n     */\n    \n    import { getUrl } from 'src/utils/reduxUtils';\n    import * as defs from '../definitions/index';\n\n    export ${inter.paramsType}\n\n    export const init = ${inter.initialValue};\n\n    export function createFetchAction(types) {\n      return (params = {}${\n        inter.bodyParams ? `, bodyParams` : \"\"\n      }, meta?: any) =\u003e {\n        return {\n          types,\n          meta,\n          method: \"${inter.method}\",\n          url: getUrl(\"${inter.path}\", params, \"${inter.method}\"),\n          ${inter.bodyParams ? \"params: bodyParams,\" : \"params,\"}\n          init: ${inter.initialValue},\n        };\n      };\n    }\n    `;\n  }\n} as Template;\n```\n\n二、使用\n\n1、swag\n\n1）如图。状态栏中的图标。如果是白色 swag(same)，说明本地 swagger 文档与远程一致。\n\n点击 swag 后，提示是否全量更新接口，点击确定可以全量更新接口。\n\n2）当后端接口有更新，状态栏出现黄色 mod(n) 或者 基类(m)。这说明有 n 个模块或者 m 个基类与远程不同需要。可以点击查看详情并更新，基类更新会写基类影响的模块。目前没有这个 case 所以截不了图\n\n3）点击同步按钮，主动同步远程数据。\n\n4）vscode 打开后，swag 每隔 10 分钟同步一次远程数据。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnefe%2Fvscode-swag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnefe%2Fvscode-swag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnefe%2Fvscode-swag/lists"}