{"id":25546976,"url":"https://github.com/fishjar/swagger-go-obsolete","last_synced_at":"2026-02-11T20:30:16.656Z","repository":{"id":37172200,"uuid":"157640515","full_name":"fishjar/swagger-go-obsolete","owner":"fishjar","description":"基于swagger.yaml文档的快速开始项目，快速生成前后端代码","archived":false,"fork":false,"pushed_at":"2022-12-22T09:29:57.000Z","size":1347,"stargazers_count":0,"open_issues_count":21,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-28T23:02:45.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fishjar.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":"2018-11-15T02:29:26.000Z","updated_at":"2024-05-28T23:02:45.913Z","dependencies_parsed_at":"2023-01-30T06:45:20.043Z","dependency_job_id":null,"html_url":"https://github.com/fishjar/swagger-go-obsolete","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fswagger-go-obsolete","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fswagger-go-obsolete/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fswagger-go-obsolete/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fswagger-go-obsolete/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fishjar","download_url":"https://codeload.github.com/fishjar/swagger-go-obsolete/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239808530,"owners_count":19700455,"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":"2025-02-20T09:19:03.523Z","updated_at":"2026-02-11T20:30:16.597Z","avatar_url":"https://github.com/fishjar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-go-obsolet\n\n- 注：本项目为早期实现的版本，后续计划请移步另一个项目： https://github.com/fishjar/swagger-go\n\n基于`swagger.yaml`文档的快速开始项目\n\n## 主要功能\n\n- 通过`swagger.yaml`生成`REST API`后端代码\n  - `nodejs`：\n    - `koajs`\n      - 包含 ORM（sequelize）\n      - 简易 JWT 验证\n    - `eggjs`\n  - `java`\n    - `spring boot`\n  - `python`\n    - `flask`\n- 通过`swagger.yaml`生成后台管理系统前端代码\n  - `Ant Design Pro`\n\n## 使用指引\n\n```sh\n# 拉取代码\ngit clone git@github.com:fishjar/swagger-go.git\n# 根据需求编辑swagger文件\nvi swagger/swagger.yaml\n\n# 生成koa后端代码\nnpm run koa\n# 运行koa后端服务\ncd dist/koa\nnpm install\nnpm run dev #开发\nnpm run build #打包\nnpm run start #启动，需要配置数据库链接\n\n#生成Ant Design Pro后台系统前端代码\nnpm run antd\n#运行Ant Design Pro\ncd dist/antd\ncnpm install\nnpm run start #开发\nnpm run build #打包\n\n#补全swagger文档\nnpm run swagger\n#运行swagger ui及swagger edit\ncd dist/swagger\ndocker-compose up\n```\n\n## 目录结构\n\n```sh\n├── bin #生成代码脚本文件\n│   ├── antd.js\n│   ├── egg.js\n│   ├── flask.js\n│   ├── koa.js\n│   ├── spring.js\n│   └── swagger.js\n├── boilerplate #项目模板\n│   ├── antd\n│   ├── egg\n│   ├── flask\n│   ├── koa\n│   └── spring\n├── config #配置文件\n│   └── index.js\n├── dist #生成文件所在文件夹\n├── lib #工具包\n├── LICENSE\n├── package.json\n├── README.md\n└── swagger #文档文件\n    └── swagger.yaml\n```\n\n## swagger 编辑说明\n\n版本基于 2.0\n\n运行`npm run swagger`会自动补全`definitions`中的`model`到`paths`，\n因此`paths`部分仅需编辑额外的接口，\n\n### 扩展字段\n\n| 字段名        | 字段类型 | 说明                        |\n| ------------- | -------- | --------------------------- |\n| x-isModel     | boolean  | 是否当做 model 处理         |\n| x-plural      | string   | model 的复数形式            |\n| x-message     | string   | andt 中的提示信息           |\n| x-showTable   | boolean  | antd 中是否显示在列表中     |\n| x-showFilter  | boolean  | antd 中是否搜索字段         |\n| x-showSorter  | boolean  | antd 列表中是否需要排序     |\n| x-isRichText  | boolean  | antd 中是否使用富文本编辑器 |\n| x-enumMap     | object   | 枚举类型的说明字典          |\n| x-description | string   | 枚举类型的说明文字          |\n| x-length      | interger | char 或 string 字段长度     |\n\n数据类型参考下面的`数据类型映射关系`表格\n\n## 数据类型映射关系\n\n| Common      | `type`    | `format`       | Mysql       | Sequelize     | SQLAlchemy              | gorm      |\n| ----------- | --------- | -------------- | ----------- | ------------- | ----------------------- | --------- |\n| integer     | `integer` | `int4`         | TINYINT     | TINYINT       | -                       | int       |\n| integer     | `integer` | `int8`         | SMALLINT    | SMALLINT      | SMALLINT/SmallInteger   | int       |\n| integer     | `integer` | `int16`        | MEDIUMINT   | MEDIUMINT     | -                       | int       |\n| integer     | `integer` | `int32`        | INTEGER     | INTEGER       | Integer/INT/INTEGER     | int       |\n| long        | `integer` | `int64`        | BIGINT      | BIGINT        | BigInteger/BIGINT       | int       |\n| float       | `number`  | `float`        | FLOAT       | FLOAT         | Float/FLOAT             | float32   |\n| double      | `number`  | `double`       | DOUBLE      | DOUBLE        | -                       | float32   |\n| double      | `number`  | `decimal`      | DECIMAL     | DECIMAL       | DECIMAL/Numeric         | float32   |\n| string      | `string`  | `char`         | CHAR        | CHAR          | String/CHAR             | string    |\n| string      | `string`  | `string`       | VARCHAR     | STRING        | String/VARCHAR          | string    |\n| string      | `string`  | `text`         | TEXT        | TEXT          | Text/TEXT/CLOB          | string    |\n| date        | `string`  | `date`         | DATE        | DATEONLY      | Date/DATE               | time.Time |\n| dateTime    | `string`  | `date-time`    | DATETIME    | DATE          | DateTime/DATETIME       | time.Time |\n| dateTime    | `string`  | `date-time(6)` | DATETIME(6) | DATE(6)       | DateTime/DATETIME       | time.Time |\n| dateTime    | `string`  | `time-stamp`   | TIMESTAMP   | -             | TIMESTAMP               | -         |\n| email       | `string`  | `email`        | VARCHAR     | STRING        | VARCHAR                 | string    |\n| uri         | `string`  | `uri`          | VARCHAR     | STRING        | VARCHAR                 | string    |\n| uri         | `string`  | `hostname`     | VARCHAR     | STRING        | VARCHAR                 | string    |\n| uri         | `string`  | `ipv4`         | VARCHAR     | STRING        | VARCHAR                 | string    |\n| uri         | `string`  | `ipv6`         | VARCHAR     | STRING        | VARCHAR                 | string    |\n| byte        | `string`  | `byte`         | VARCHAR     | STRING        | VARCHAR                 | string    |\n| binary      | `string`  | `binary`       | BLOB/BINARY | STRING.BINARY | LargeBinary/BINARY/BLOB | -         |\n| password    | `string`  | `password`     | VARCHAR     | STRING        | -                       | string    |\n| uuid        | `string`  | `uuid`         | CHAR(36)    | UUID/UUIDV1   | -                       | string    |\n| object/dict | `string`  | `json`         | JSON        | JSON          | JSON                    | string    |\n| object/dict | `object`  | `object`       | JSON        | JSON          | JSON                    | string    |\n| array       | `array`   | `array`        | JSON        | JSON          | ARRAY                   | string    |\n| boolean     | `boolean` | `boolean`      | TINYINT(1)  | BOOLEAN       | Boolean/BOOLEAN         | bool      |\n| enum        | \\*        | `enum`         | ENUM        | ENUM          | Enum                    | -         |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishjar%2Fswagger-go-obsolete","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffishjar%2Fswagger-go-obsolete","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishjar%2Fswagger-go-obsolete/lists"}