SwaggerOpenAPI 到人类可读文档（Excel、Word ...）的转换

Swagger/OpenAPI是一种用于描述和定义RESTful API的规范。它可以帮助开发者更好地理解和使用API，同时也可以为团队协作提供便利。然而，Swagger/OpenAPI的规范文件通常是面向机器的，对于非技术人员来说并不容易理解。为了解决这个问题，我们可以通过将Swagger/OpenAPI转换为人类可读的文档，如Excel或Word，从而使其更易于理解和使用。

python
import swagger_parser
# 解析规范文件
swagger_file = 'path/to/swagger.yaml'
spec = swagger_parser.load_file(swagger_file)
# 获取API信息
paths = spec['paths']
definitions = spec['definitions']

python
from openpyxl import Workbook
# 创建工作簿和工作表
workbook = Workbook()
sheet = workbook.active
# 添加标题
sheet['A1'] = 'API名称'
sheet['B1'] = 'API路径'
sheet['C1'] = '请求方法'
sheet['D1'] = '请求参数'
sheet['E1'] = '响应参数'
# 添加API信息
row = 2
for path, methods in paths.items():
    for method, details in methods.items():
        sheet[f'A{row}'] = details['summary']
        sheet[f'B{row}'] = path
        sheet[f'C{row}'] = method
        sheet[f'D{row}'] = ', '.join(details['parameters'])
        sheet[f'E{row}'] = ', '.join(details['responses'])
        row += 1
# 保存文档
workbook.save('path/to/api_document.xlsx')

python
# 生成文档内容
document = ''
for path, methods in paths.items():
    for method, details in methods.items():
        document += f'{details["summary"]}\n'
        document += f'路径：{path}\n'
        document += f'方法：{method}\n'
        document += f'请求参数：{", ".join(details["parameters"])}\n'
        document += f'响应参数：{", ".join(details["responses"])}\n\n'
# 保存文档
with open('path/to/api_document.txt', 'w') as file:
    file.write(document)