如何将在线接口文档通过Excel导出

原创

已于 2022-09-29 11:17:08 修改 · 1.8k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#json #接口文档

于 2022-09-29 11:13:08 首次发布

该博客介绍了一种方法，将Swagger接口定义的JSON数据转换为Excel格式，便于查看和管理。通过读取JSON文件，解析请求路径、方法、接口分类、描述、参数和响应，然后将这些信息写入Excel表格中，实现数据的可视化。适用于需要整理API文档的开发者。

需求：将swagger接口JSON文件转化为Excel格式查看，如下格式

过程

先复制swagger接口的JSON数据，然后保存为txt文件。

代码脚本将文件转化为Excel

文档接口清单

import json

import xlwt

api_excel = xlwt.Workbook(encoding='utf-8')  # 创建一个文档
api_sheet = api_excel.add_sheet('XX项目接口')  # 添加一个sheet
json_file = open('api-docs.txt', encoding='utf-8')  # 打开保存的swagger文本文档
api_data = json.load(json_file)  # 将文档json内容转换为Python对象
api = api_data['paths']  # 取swagger文件内容中的path，文件中path是键名
path_list = []  # 创建接口地址空列表
method_list = []  # 创建请求方式空列表
tags_list =