icinfo-tool-api

api自动化生成代码工具

解析后端的微服务api文档，自动生成所需要的接口函数（TS格式的）

引入的命令

npm i -D git+ssh://git@gitlab.icinfo.co:fed/tool.api.git#v0.2.7

基本用法案例

在需要的项目中创建一个文件，比如 api.ts

import axios from 'axios';

import { cleanDir } from 'tutils/fileSystemSync';
import { generate } from 'api-server';

async function main() {
  try {
    cleanDir('src/api');
  } catch (e) {
    // eslint-disable-next-line no-console
  console.log(e);
  }

    [
        'http://api.fed.icinfo.co/xyxf/xyxf_zzgl/develop/api.json',
        'http://api.fed.icinfo.co/xyxf/origin-framework-cloud/member/api.json',
        'http://api.fed.icinfo.co/business-component/check-form/develop/api.json',
    ].forEach(async (url) => {
    const result = await axios(url);

    generate(result.data, {
      tsDir: 'src/api',
      merge: true,
      request: 'request',
      prepend: 'import {request, RequestOptions} from "@/untils/http"',
      optionsType: 'RequestOptions',
      dataDescription: '要提交给服务器的数据',
      optionsDescription: '附加选项',
    });

    // eslint-disable-next-line no-console
    console.log('已成功生成：', url.replace(/\/api\.json$/, ''));
  });
}

main();

同时在package.json配置scripts

"api": "ts-node ./scripts/api.ts"

执行方法为

npm run api

可配置的参数