Swagger UI 生成docx

• 需求说明    

       用FastAPI搭建服务器

      自动生成Swagger UI

      通过访问服务器地址+/openapi.json获取接口文档的json数据

       将json数据为word文档(用于:写文档!!!!)

• 注意事项

        openapi.json中的key很特殊,是以api接口路径作为key,以及访问方法作为key;

        只有在接口当中注释说明才会产生description字段

• 实现过程

import json
import requests
from typing import List
from docx import Document
# 创建document对象
def createApiworld(titleCol:list,data:List[List[str]])->any:
    document = Document()
    # 添加普通文本
    document.add_heading('接口文档', level=0)
    # document.add_paragraph('接口文档')
    # 列数
    rowNumber=len(data)
    # 行数
    colNumber=len(titleCol)
    # 添加表格
    table = document.add_table(rows=rowNumber+1, cols=colNumber)
    # 表头设置
    row0 = table.rows[0].cells
    for row in range(colNumber):
        row0[row].text= titleCol[row]
    rows = data
    # 每一行数据填充
    for row in range(rowNumber):
        cells = table.rows[row+1].cells
        for col in range(colNumber):
            cells[col].text = rows[row][col]
    # 保存路径
    document.save('D:\Document\demo.docx')

# 处理json数据
def jsonData(url:str)->dict:
    res = requests.get(url)
    data=json.loads(res.text)['paths']
    lst=[]
    for address in data:
        lstItem=[]
        lstItem.append(address)
        for method in data[address]:
            lstItem.append(method)
            lstItem.append(data[address][method]['description'])
        lst.append(lstItem)
    createApiworld(['地址','方法','说明'],lst)
    return {'message':'成功'}
# 定义请求url和传入的data
url = "http://localhost:8000/openapi.json"
jsonData(url)

结果