1 Star 0 Fork 7

bobo / nswag-ts

forked from 惊鸦 / nswag-ts 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

nswag-ts

介绍

根据 swagger 文档生成 typescript 客户端调用代码

安装教程

  1. npm i nswag-ts -D

使用说明

  1. 在 package.json 的 scripts 节点增加 2 个执行命令
  • "nswag-init":"nswag init", // 初始化配置

  • "nswag-run":"nswag run" // 执行代码生成

  • 第一步执行:npm run nswag-init 初始化项目

  • 初始化完成后会在项目根目录创建文件夹 nswag,里面放置了配置文件及代码模板

  • 修改配置文件和代码模板就可以进行第二步生成操作了

  • config.js 为配置文件

    • 配置所有需要生成的接口,及相应的生成规则,详见 【配置参数】
  • tpl 文件里面是代码模板(可以根据自己的实际情况调整模板)

    • base.ejs 接口调用基类模板,默认使用了 axios
    • method.ejs 接口函数生成模板
    • model.ejs 接口对象生成模板
    • mock.ejs 模拟数据代码生成模板-调用
    • mock-method.ejs 模拟数据代码生成模板-接口实例
  • 第二步执行:npm run nswag-run 执行代码生成调用接口

配置参数

{
  Name: 'nswag-ts',
  Description: '根据swagger文档生成typescript客户端调用代码',
  Apis: [
    {
      SwaggerUrl: string // 接口文档地址(必填)
      ApiBase: string // 接口根节点(必填)
      ApiName: string // 接口名称(必填)
      OutPath: string // 输出目录(默认:项目根目录:/src/api/)
      TplPath: string // 模板路径(默认:初始化后会自动copy模板文件夹到项目根目录:nswag,如果进行了修改则需配置此目录)
      Mock: boolean // 是否启用模拟数据 (默认:false)
      FormatMock: Function // 接管模拟数据格式化
      FormatControllerName: Function // 格式化模块名称(默认:接口名称+Api)
      FormatMethodName: Function // 格式化接口名称(默认:小驼峰命名)
      FormatModelName: Function // 格式化dto对象、枚举名称(默认:只会去除特殊字符)
    }
  ]
}
格式化函数示例
// 格式化模型
function formatModelName(n) {
  // TODO 预处理掉乱七八糟的字符
  return n.replace(/`1/g, '')
}

// 格式化模拟数据
function formatMock(val, p, mock) {
  switch (p.Type.TypeOf) {
    case 'string':
      switch (p.Name) {
        case 'name':
          val = '@cname'
          break
        case 'title':
          val = '@ctitle(10, 20)'
          break
        case 'mobile':
          val = '@natural(10000)'
          break
        case 'email':
          val = '@email'
          break
        case 'province':
          val = '@province'
          break
        case 'city':
          val = '@city'
          break
        case 'area':
          val = '@county'
          break
        default:
          val = '@ctitle(10, 20)'
          break
      }
      mock[p.Name] = val
      break
    case 'number':
      switch (p.Name) {
        case 'result_code':
          val = 0
          break
        case 'page_index':
          val = 1
          break
        case 'page_size':
          val = 15
          break
        case 'total_count':
          val = 30
          break
        default:
          val = '@integer(0, 100)'
          break
      }
      mock[p.Name] = val
      break
    case 'array':
      mock[p.Name + '|20'] = val
      break
  }
  return mock
}

代码仓库

  1. https://gitee.com/money-code/nswag-ts
  2. https://www.npmjs.com/package/nswag-ts
MIT License Copyright (c) 2020 何泽长 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

根据swagger文档生成typescript客户端调用代码 展开 收起
JavaScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/wxynf4/nswag-ts.git
git@gitee.com:wxynf4/nswag-ts.git
wxynf4
nswag-ts
nswag-ts
master

搜索帮助