yapi-apifox-to-typescript 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-present Jay Fong <fjc0kb@gmail.com>
+
+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.

package/README.md

@@ -0,0 +1,5 @@
+# YApi to TypeScript
+
+本项目基于 [yapi-to-typescript v3.38.0](https://github.com/fjc0k/yapi-to-typescript)
+
+在此基础上补充了 Apifox 接口的转换，增加了一些基础配置项以减轻生成的代码量。

package/lib/cjs/ApifoxToYApiData.js

@@ -0,0 +1,299 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+exports.__esModule = true;
+exports.ApifoxToYApiData = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _axios = _interopRequireDefault(require("axios"));
+
+var _types = require("./types");
+
+var ApifoxToYApiData = /*#__PURE__*/function () {
+  function ApifoxToYApiData(options) {
+    this.options = options;
+    this.schemas = void 0;
+    this.folders = void 0;
+    this.project = {
+      _id: 0,
+      _url: '',
+      name: 'ApifoxProject',
+      desc: '',
+      basepath: '',
+      tag: [],
+      env: [{
+        name: '',
+        domain: ''
+      }]
+    };
+    this.schemas = {};
+    this.folders = [];
+  }
+  /**
+   * http-api-tree 这个接口拿到所有的folder（category）
+   * data-schemas 这个接口拿到所用通用的schema
+   */
+
+
+  var _proto = ApifoxToYApiData.prototype;
+
+  _proto.getProjectInfo =
+  /*#__PURE__*/
+  function () {
+    var _getProjectInfo = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+      var _this = this;
+
+      var folders, schemas, cats;
+      return _regenerator.default.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return _axios.default.get("https://apifox.com/api/v1/shared-docs/" + this.options.token + "/http-api-tree");
+
+            case 2:
+              folders = _context.sent;
+              _context.next = 5;
+              return _axios.default.get("https://apifox.com/api/v1/shared-docs/" + this.options.token + "/data-schemas");
+
+            case 5:
+              schemas = _context.sent;
+              // 初始化
+              // this.schemas = schemas.data.data
+              schemas.data.data.forEach(function (item) {
+                _this.schemas[item.id] = item.jsonSchema;
+              });
+              this.folders = folders.data.data;
+              cats = folders.data.data.map(function (item) {
+                return {
+                  _id: item.folder.id,
+                  _url: '',
+                  name: item.name,
+                  desc: item.key,
+                  list: [],
+                  add_time: 0,
+                  up_time: 0
+                };
+              });
+              this.project._id = schemas.data.data[0].projectId;
+              return _context.abrupt("return", (0, _extends2.default)({}, this.project, {
+                cats: cats,
+                getMockUrl: function getMockUrl() {
+                  return '';
+                },
+                getDevUrl: function getDevUrl() {
+                  return '';
+                },
+                getProdUrl: function getProdUrl() {
+                  return '';
+                }
+              }));
+
+            case 11:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee, this);
+    }));
+
+    function getProjectInfo() {
+      return _getProjectInfo.apply(this, arguments);
+    }
+
+    return getProjectInfo;
+  }()
+  /**
+   * 由于yapi中基本没有处理ref的方案
+   * 都是直接由具体的参数值管理，所以这里需要对所有的ref进行转换
+   * TODO：目前这里只考虑了一个层级，如果是多个层级，需要再递归处理
+   */
+  ;
+
+  _proto.getInterfaceList =
+  /*#__PURE__*/
+  function () {
+    var _getInterfaceList = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(syntheticalConfig) {
+      var _this2 = this;
+
+      var cat, transformRefToSchema;
+      return _regenerator.default.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              // syntheticalConfig.id 就是catId
+              cat = this.folders.find(function (item) {
+                return item.folder.id === syntheticalConfig.id;
+              });
+
+              if (cat) {
+                _context3.next = 3;
+                break;
+              }
+
+              return _context3.abrupt("return", []);
+
+            case 3:
+              transformRefToSchema = function transformRefToSchema(refString) {
+                var refId = refString.split('/').pop();
+                return _this2.schemas[refId];
+              };
+
+              return _context3.abrupt("return", Promise.all(cat.children.map( /*#__PURE__*/function () {
+                var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(item) {
+                  var _resultData$responses, _resultData$responses2, _resultData$responses3, _resultData$responses4, _resultData$responses5, _resultData$responses6, _resultData$responses7, _resultData$requestBo, _resultData$requestBo2, _resultData$parameter, _resultData$parameter2;
+
+                  var result, resultData, resbodyIndex, respref, dataProperties, _item, _dataProperties$_item, dataPropRef, reqref;
+
+                  return _regenerator.default.wrap(function _callee2$(_context2) {
+                    while (1) {
+                      switch (_context2.prev = _context2.next) {
+                        case 0:
+                          _context2.next = 2;
+                          return _axios.default.get("https://apifox.com/api/v1/shared-docs/" + _this2.options.token + "/http-apis/" + item.api.id);
+
+                        case 2:
+                          result = _context2.sent;
+                          resultData = result.data.data; // 根据result对应的param查询制定的schema
+
+                          // 根据result对应的param查询制定的schema
+                          resbodyIndex = resultData.responses.findIndex(function (item) {
+                            return item.code === 200;
+                          }); // 处理response重可能存在ref
+
+                          // 处理response重可能存在ref
+                          respref = (_resultData$responses = resultData.responses[resbodyIndex].jsonSchema) == null ? void 0 : (_resultData$responses2 = _resultData$responses.properties) == null ? void 0 : (_resultData$responses3 = _resultData$responses2.data) == null ? void 0 : (_resultData$responses4 = _resultData$responses3.items) == null ? void 0 : _resultData$responses4.$ref;
+
+                          if (respref) {
+                            // @ts-ignore
+                            resultData.responses[resbodyIndex].jsonSchema.properties.data.items = transformRefToSchema(respref);
+                          } // 处理data中可能存在ref的问题
+                          // 这里只考虑了一层，如果存在多层，需要递归处理
+
+
+                          // 处理data中可能存在ref的问题
+                          // 这里只考虑了一层，如果存在多层，需要递归处理
+                          dataProperties = (_resultData$responses5 = resultData.responses[resbodyIndex].jsonSchema) == null ? void 0 : (_resultData$responses6 = _resultData$responses5.properties) == null ? void 0 : (_resultData$responses7 = _resultData$responses6.data) == null ? void 0 : _resultData$responses7.properties;
+
+                          if (dataProperties) {
+                            for (_item in dataProperties) {
+                              // @ts-ignore
+                              dataPropRef = (_dataProperties$_item = dataProperties[_item].items) == null ? void 0 : _dataProperties$_item['$ref']; // @ts-ignore
+
+                              // @ts-ignore
+                              if (dataProperties[_item].type === 'array' && dataPropRef) {
+                                // @ts-ignore
+                                resultData.responses[resbodyIndex].jsonSchema.properties.data.properties[_item].items = transformRefToSchema(dataPropRef);
+                              }
+                            }
+                          } // 处理request中可能存在的ref
+
+
+                          // 处理request中可能存在的ref
+                          if ((_resultData$requestBo = resultData.requestBody.jsonSchema) != null && _resultData$requestBo['x-apifox-refs'] && (_resultData$requestBo2 = resultData.requestBody.jsonSchema) != null && _resultData$requestBo2['x-apifox-orders']) {
+                            // @ts-ignore
+                            reqref = resultData.requestBody.jsonSchema['x-apifox-refs'][resultData.requestBody.jsonSchema['x-apifox-orders'][0]];
+                            resultData.requestBody.jsonSchema.properties = transformRefToSchema(reqref['$ref']).properties; // @ts-ignore
+
+                            // @ts-ignore
+                            resultData.requestBody.jsonSchema['required'] = reqref.required;
+                            delete resultData.requestBody.jsonSchema['x-apifox-refs'];
+                            delete resultData.requestBody.jsonSchema['x-apifox-orders'];
+                          }
+
+                          return _context2.abrupt("return", {
+                            _id: resultData.id,
+                            _category: {
+                              _id: syntheticalConfig.id,
+                              _url: '',
+                              name: cat.name,
+                              desc: '',
+                              add_time: 0,
+                              up_time: 0,
+                              list: []
+                            },
+                            _project: (0, _extends2.default)({}, _this2.project),
+                            _url: '',
+                            title: resultData.name,
+                            status: 'undone',
+                            markdown: resultData.operationId,
+                            path: resultData.path,
+                            method: resultData.method.toUpperCase(),
+                            project_id: resultData.projectId,
+                            catid: syntheticalConfig.id,
+                            tag: resultData.tags,
+                            req_headers: resultData.requestBody.type ? [{
+                              name: 'Content-Type',
+                              value: resultData.requestBody.type,
+                              desc: '',
+                              example: '',
+                              required: _types.Required.true
+                            }] : [],
+                            req_params: ((_resultData$parameter = resultData.parameters.path) == null ? void 0 : _resultData$parameter.map(function (item) {
+                              return {
+                                name: item.name,
+                                desc: item.description,
+                                example: '',
+                                required: item.required ? _types.Required.true : _types.Required.false,
+                                type: item.type === 'string' ? _types.RequestParamType.string : _types.RequestParamType.number
+                              };
+                            })) || [],
+                            req_query: ((_resultData$parameter2 = resultData.parameters.query) == null ? void 0 : _resultData$parameter2.map(function (item) {
+                              return {
+                                name: item.name,
+                                desc: item.description,
+                                example: '',
+                                required: item.required ? _types.Required.true : _types.Required.false,
+                                type: item.type === 'string' ? _types.RequestQueryType.string : _types.RequestQueryType.number
+                              };
+                            })) || [],
+                            req_body_type: resultData.requestBody.jsonSchema ? _types.RequestBodyType.json : _types.RequestBodyType.raw,
+                            req_body_is_json_schema: !!resultData.requestBody.jsonSchema,
+                            req_body_form: [],
+                            req_body_other: resultData.requestBody.jsonSchema ? JSON.stringify(resultData.requestBody.jsonSchema) : '',
+                            res_body_type: _types.ResponseBodyType.json,
+                            res_body_is_json_schema: true,
+                            res_body: JSON.stringify(resultData.responses[resbodyIndex].jsonSchema),
+                            add_time: Math.floor(new Date(resultData.createdAt).getTime() / 1000),
+                            up_time: Math.floor(new Date(resultData.updatedAt).getTime() / 1000),
+                            uid: 0
+                          });
+
+                        case 11:
+                        case "end":
+                          return _context2.stop();
+                      }
+                    }
+                  }, _callee2);
+                }));
+
+                return function (_x2) {
+                  return _ref.apply(this, arguments);
+                };
+              }())));
+
+            case 5:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3, this);
+    }));
+
+    function getInterfaceList(_x) {
+      return _getInterfaceList.apply(this, arguments);
+    }
+
+    return getInterfaceList;
+  }();
+
+  return ApifoxToYApiData;
+}();
+
+exports.ApifoxToYApiData = ApifoxToYApiData;