swagger使用javascript sdk

本文档介绍了如何使用Swagger编辑器生成JavaScript SDK,并在项目中进行集成。首先,通过后台导出的.yaml文件在Swagger Edit中导入并生成客户端包。接着,解压SDK,使用npm本地打包并链接到项目。在项目中,需要修改webpack配置以避免报错。Swagger SDK提供的docs文件夹包含了API详细说明,model文件夹中的js文件用于实现API,提供构造函数辅助传递参数,降低拼写错误风险。每次删除node_modules后,需重新安装包括Swagger SDK的依赖。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

由后台开发人员导出.yaml文件  在swagger edit里面File下导入  在Generate Client目录里面下载javascript包

解压并按照 readme文件 通过npm 进行本地打包并npm link 映射到相应的项目(需要使用管理员权限打包)

打包成功后 正常情况在在安装node的目录里面的node_module里面可以看到这个包  本机地址为:

C:\Program Files\nodejs\node_modules\x_field_api

(此处包名为:x_field_api)

管理员权限下 进入自己的项目  在项目里执行npm link 包名

npm link x_field_api

注意此种方式引用需要在项目里build/webpack.base.conf.js的里面增加配置,否则会报错

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

随后即可在项目里面通过require引用 如:

var XFieldApi = require("x_field_api");

提示:从swagger edit 上下载的javascript sdk解压后文件夹里有一个docs文件  里面有你对应的APi的文件分别详细记录了每个APi的调用方法的具体写法(比如此处的AccountApi.md

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值