Python實(shí)現(xiàn)處理apiDoc轉(zhuǎn)swagger的方法詳解
更新時(shí)間：2023年02月02日 08:46:27 作者：七仔的博客
這篇文章主要為大家詳細(xì)介紹了Python實(shí)現(xiàn)處理apiDoc轉(zhuǎn)swagger的方法，文中的示例代碼講解詳細(xì)，具有一定的學(xué)習(xí)價(jià)值，感興趣的小伙伴可以了解一下
需要轉(zhuǎn)換的接口
現(xiàn)在我需要轉(zhuǎn)換的接口全是nodejs寫的數(shù)據(jù)，而且均為post傳輸?shù)膉son格式接口
apiDoc格式
apiDoc代碼中的格式如下：
/**
* @api {方法} 路徑 標(biāo)題
* @apiGroup Group
* @apiDescription 描述這個(gè)API的信息
*
* @apiParam {String} userName 用戶名
* @apiParamExample {json} request-example
* {
* "userName": "Eve"
* }
*
* @apiError {String} message 錯(cuò)誤信息
* @apiErrorExample {json} error-example
* {
* "message": "用戶名不存在"
* }
*
*
* @apiSuccess {String} userName 用戶名
* @apiSuccess {String} createTime 創(chuàng)建時(shí)間
* @apiSuccess {String} updateTime 更新時(shí)間
* @apiSuccessExample {json} success-example
* {
* "userName": "Eve",
* "createTime": "1568901681"
* "updateTime": "1568901681"
* }
*/function getUserInfo(username) {
// 假如這個(gè)函數(shù)是根據(jù)用戶名返回用戶信息的
}
使用npm安裝apidoc插件：
npm install apidoc
再新建對(duì)應(yīng)的apidoc.json，格式如下：
{
"name": "文檔名",
"version": "版本號(hào)",
"description": "解釋",
"title": "標(biāo)題",
"url" : "地址"
}
然后在apidoc.json路徑下執(zhí)行命令可以生成接口文檔（src是接口代碼文件夾，apidoc是生成文檔的文件夾）：
apidoc -i src/ -o apidoc/
生成后可以在apidoc文件夾中打開index.html查看生成的接口文檔，生成文檔時(shí)會(huì)生成一個(gè)api_data.json，下面會(huì)用到
swagger格式
這里我們暫時(shí)只需要關(guān)注參數(shù)為json的接口格式
{
"swagger": "2.0",
"info": {
"description": "1.0版本接口文檔",
"version": "1.0.5",
"title": "智能醫(yī)療輔助平臺(tái)",
"termsOfService": "http://swagger.io/terms/"
},
"host": "http://localhost:8080",
"basePath": "/",
"tags": [],
"paths": {},
"definitions": {}
}
其中path是存放接口的，tags是存放的分組名列表，definitions是實(shí)體列表（json參數(shù)）
思路
使用apidoc包生成apidoc的json格式數(shù)據(jù)，然后使用python讀取出接口地址、名字、組名、輸入?yún)?shù)格式和例子、輸出參數(shù)格式和例子等，然后根據(jù)swagger格式填入對(duì)應(yīng)的數(shù)據(jù)即可生成swagger的json格式
我的話是會(huì)直接使用處理出的swagger的json格式的數(shù)據(jù)導(dǎo)入yApi中
代碼
代碼雖然在下面，但是是我臨時(shí)著急用寫的，有的地方是寫死的，需要改，這里放出來(lái)主要是講個(gè)大致的思路
import re
import json
import demjson
import decimal
# 保存時(shí)會(huì)出現(xiàn)byte格式問題，使用這個(gè)處理
class DecimalEncoder(json.JSONEncoder):
def default(self, o):
if isinstance(o, decimal.Decimal):
return float(o)
super(DecimalEncoder, self).default(o)
# 分析例子轉(zhuǎn)json，在這里可以自己添加規(guī)則
def analyze_demjson(json_data):
item = json_data.replace("\\n", "").replace("\\", "").replace(" ", "")
result_item = {}
try:
result_item = demjson.decode(item, encoding='UTF-8')
except:
print(item)
return result_item
# 獲取解析apidoc數(shù)據(jù)
def get_api_doc_data(name):
data_list = None
group_list = {}
with open(name, mode='r', encoding="UTF-8") as f:
data_list = json.load(f)
for data in data_list:
if data['group'] in group_list:
group_list[data['group']].append(data)
else:
group_list[data['group']] = [data]
return group_list
# 轉(zhuǎn)為swagger寫入
def set_swagger_data(data):
swagger_json = {
"swagger": "2.0",
"info": {
"description": "1.0版本接口文檔",
"version": "1.0.5",
"title": "智能醫(yī)療輔助平臺(tái)",
"termsOfService": "http://swagger.io/terms/"
},
"host": "http://localhost:8080",
"basePath": "/",
"tags": [],
"paths": {},
"definitions": {}
}
# 添加分組
for group_key in data:
swagger_json['tags'].append({
"name": group_key,
"description": group_key
})
# 添加接口信息
# 循環(huán)分組
for group_key in data:
# 循環(huán)每組列表
for interface in data[group_key]:
parameters = {}
if 'parameter' in interface and 'fields' in interface['parameter']:
# 獲取參數(shù)demo信息
content = ""
if 'examples' in interface['parameter']:
content = analyze_demjson(interface['parameter']['examples'][0]['content'])
# 添加參數(shù)信息
parameter_dict = {}
for parameter in interface['parameter']['fields']['Parameter']:
parameter_type = "None"
if "type" in parameter:
parameter_type = parameter['type'].lower()
if parameter_type == 'number':
parameter_type = "integer"
parameter_item = {
"description": parameter['description'].replace('<p>', '').replace('</p>', ''),
"required": parameter['optional'],
"type": parameter_type,
"default": ''
}
if parameter['field'] in content:
parameter_item['default'] = content[parameter['field']]
parameter_dict[parameter['field']] = parameter_item
parameters = {
"in": "body",
"name": interface['name'],
"description": interface['name'],
"required": "true",
"schema": {
"originalRef": interface['name'],
"$ref": "#/definitions/" + interface['name']
}
}
swagger_json['definitions'][interface['name']] = {
"type": "object",
"properties": parameter_dict
}
# 添加返回信息
responses = {
"200": {
"description": "successful operation",
"schema": {
"originalRef": interface['name'] + "_response",
"$ref": "#/definitions/" + interface['name'] + "_response"
}
}
}
schema = {
"type": "object",
"properties": {
"errcode": {
"type": "integer",
"default": 0,
"description": "編碼，成功返回1"
},
"data": {
"type": "object",
"default": {},
"description": "監(jiān)管對(duì)象明細(xì),包含表頭和數(shù)據(jù)內(nèi)容兩部分"
},
"errmsg": {
"type": "string",
"default": "ok",
"description": '編碼提示信息，成功時(shí)返回 "ok"'
}
}
}
# 返回例子
if "success" in interface:
response_example = ""
if len(interface['success']['examples']) == 1:
response_example = analyze_demjson(interface['success']['examples'][0]['content'])
else:
response_example = analyze_demjson(interface['success']['examples']['content'])
if 'data' in response_example and response_example['data'] != {}:
schema['properties']['data'] = response_example['data']
swagger_json['definitions'][interface['name'] + "_response"] = schema
# 加入
swagger_json['paths'][interface['url']] = {
interface['type']: {
"tags": [group_key],
"summary": interface['title'].replace(interface['url'] + '-', ''),
"description": interface['title'],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [parameters],
"responses": responses
}}
# 寫入json文件
with open('swagger_data.json', 'w', encoding="UTF-8") as json_file:
json.dump(swagger_json, json_file, cls=DecimalEncoder, indent=4, ensure_ascii=False)
if __name__ == '__main__':
group_data = get_api_doc_data('api_data.json')
set_swagger_data(group_data)到此這篇關(guān)于Python實(shí)現(xiàn)處理apiDoc轉(zhuǎn)swagger的方法詳解的文章就介紹到這了,更多相關(guān)Python apiDoc轉(zhuǎn)swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:
相關(guān)文章
@符號(hào)用做函數(shù)的修飾符,可以在模塊或者類的定義層內(nèi)對(duì)函數(shù)進(jìn)行修飾,下面這篇文章主要給大家介紹了關(guān)于Python中@符號(hào)是什么意思的相關(guān)資料,需要的朋友可以參考下2021-09-09
python flask sqlalchemy連接數(shù)據(jù)庫(kù)流程介紹
這篇文章主要介紹了python flask sqlalchemy連接數(shù)據(jù)庫(kù)流程，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
2022-09-09 
Python學(xué)習(xí)之用pygal畫世界地圖實(shí)例
這篇文章主要介紹了Python學(xué)習(xí)之用pygal畫世界地圖實(shí)例，具有一定借鑒價(jià)值，需要的朋友可以參考下。
2017-12-12 
這篇文章主要介紹了Python爬蟲框架Scrapy實(shí)例代碼,需要的朋友可以參考下
2018-03-03 
Python數(shù)據(jù)分析之獲取雙色球歷史信息的方法示例
這篇文章主要介紹了Python數(shù)據(jù)分析之獲取雙色球歷史信息的方法,涉及Python網(wǎng)頁(yè)抓取、正則匹配、文件讀寫及數(shù)值運(yùn)算等相關(guān)操作技巧,需要的朋友可以參考下
2018-02-02 
Python基于lxml模塊解析html獲取頁(yè)面內(nèi)所有葉子節(jié)點(diǎn)xpath路徑功能示例
這篇文章主要介紹了Python基于lxml模塊解析html獲取頁(yè)面內(nèi)所有葉子節(jié)點(diǎn)xpath路徑功能,結(jié)合實(shí)例形式較為詳細(xì)的分析了Python使用lxml模塊進(jìn)行xml節(jié)點(diǎn)數(shù)據(jù)解析的相關(guān)操作技巧與注意事項(xiàng),需要的朋友可以參考下
2018-05-05 
這篇文章主要介紹了python+flask編寫接口實(shí)例詳解，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
2021-05-05 
Python爬蟲天氣預(yù)報(bào)實(shí)例詳解（小白入門）
這篇文章主要介紹了Python爬蟲天氣預(yù)報(bào)實(shí)例詳解（小白入門），詳細(xì)介紹了整個(gè)爬蟲建立的流程，最后分享了實(shí)現(xiàn)代碼，很簡(jiǎn)潔，小編覺得還是挺不錯(cuò)的，具有一定借鑒價(jià)值，需要的朋友可以參考下
2018-01-01 
解決Python下imread,imwrite不支持中文的問題
今天小編就為大家分享一篇解決Python下imread,imwrite不支持中文的問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧
2018-12-12