python实现swagger自动转Js SDK

在做前后端分离项目的时候,我们经常还要一层`JSDK`来存放我们的后端请求,后端加一个前端也要加一个,有时候就感觉很麻,有感而发,就想自己搞一个代码生成工具,其实后面还可以开发代码自动生成工具,但是都自动生成了,还有程序员干啥,这个就暂时不写(实际上是作者写不出来),来看看下面的代码

```python

# -*- 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()

```

调用方式

```python

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`层了

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,063评论 6 510
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,805评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,403评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,110评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,130评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,877评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,533评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,429评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,947评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,078评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,204评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,894评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,546评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,086评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,195评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,519评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,198评论 2 357

推荐阅读更多精彩内容