python實現swagger自動轉Js SDK

在做前後端分離項目的時候，我們經常還要一層JSDK來存放我們的後端請求，後端加一個前端也要加一個，有時候就感覺很麻，有感而發，就想自己搞一個代碼生成工具，其實後面還可以開發代碼自動生成工具，但是都自動生成了，還有程序員幹啥，這個就暫時不寫（實際上是作者寫不出來），來看看下面的代碼

# -*- coding: UTF-8 -*-
import os
import re
from urllib import request
import json


class Tool:
    """
    swagger 轉js sdk工具類
    """

    def __init__(self, host, dir_path):
        """
        :param host:遠程json文件地址
        :param dir_path: 寫入文件目錄
        """
        self.host = host
        self.dir_path = dir_path

    def raise_api(self):
        url = self.host
        req = request.Request(url)
        res = request.urlopen(req)
        res = json.loads(res.read().decode('utf-8'))
        paths = res['paths']
        # 清空文件
        self.clear_file()

        # 存放方法字符串數據
        for x in paths:
            path = x
            tmp_x = x[1:-1]
            method_name = re.sub(r'\/|-', '_', re.sub('{|}', '', tmp_x))
            file_name = method_name.split('_')[0]

            params = re.findall(r'.*?\{(.*?)\}.*?', path)
            if params:
                params.append('params')
                params = tuple(params).__str__()
            else:
                params = '(params)'
            for method in paths[x]:
                # 過濾掉路徑中的 parameters
                if method == 'parameters':
                    continue
                tmp_method_name = self.request_methods(paths[x][method]['operationId'], method, params)
                fun_content_str = self.fun_content(method, path)
                desc = ''
                if 'description' in paths[x][method]:
                    desc = paths[x][method]['description']
                note = self.raise_note(path, desc)
                if os.path.exists(self.dir_path + file_name + '.js'):
                    pass
                else:
                    self.init_file(file_name + '.js')
                fun_str = '%s%s%s\n' % (note, tmp_method_name, fun_content_str)
                file = open(self.dir_path + file_name + '.js', 'a')
                file.write(fun_str)
                file.close()

    def request_methods(self, fun_name, method, params):
        """
        構造方法名
        :param fun_name:
        :param params:
        :return:
        """
        return 'export const %s = %s => {\n' % (re.sub(r'_(v1|v2|v3|0)', '', fun_name), re.sub(r'\'', '', params))

    def fun_content(self, method, path):
        """
        構造方法內容
        :param method:
        :param path:
        :return:
        """
        return '    return http.%s(`%s`, params)\n}\n' % (method, re.sub(r'\{', '${', path))

    def raise_note(self, path, description):
        """
        生成註釋
        :param path:
        :param description:
        :return:
        """
        return '/**\n * path: %s\n * description: %s\n */\n' % (path, re.sub(r'\n', ' \n * ', description))

    def clear_file(self):
        """
        清空文件
        :return:
        """
        files = os.listdir(self.dir_path)
        for x in files:
            if os.path.exists(self.dir_path + x):
                file = open(self.dir_path + x, 'w')
                file.truncate()
                file.write('''/**
 * %s API
 */\n
import http from 'src/utils/http'\n
''' % (re.sub(r'.js', '', x)))
                file.close()

    def init_file(self, file_name):
        """
        初始化文件，主要是初始化頭部
        :param file_name:
        :return:
        """
        file = open(self.dir_path + file_name, 'w')
        file.write('''/**
 * %s API
 */\n
import http from 'src/utils/http'\n
''' % (re.sub(r'.js', '', file_name)))
        file.close()

調用方式

from app.swagger2js import tool
# json的地址
url = 'http://192.168.2.22:5002/swagger.json'
# 保證你的同級目錄下面有sdk這個文件夾，我懶，我不想檢測有沒有這個文件夾
dir_path = os.getcwd() + '\sdk\\'
tmp = tool.Tool(url, dir_path)
tmp.raise_api()

該方法適用swagger和用YAPI導出的json，來一來看一看大家以後不用謝sdk層了