[star7th/showdoc]寻求一份runAPI的开放接口文档,page_content的内容应该写成什么格式,才可以被runAPI客户端识别

2024-08-05 434 views
7

【背景】 业务场景:迭代了四年的项目优化字段,需要前端检查接口的字段是否在项目代码中中是否被使用。人工查询工作量会因为组件嵌套层数,核查工作量指数级增长。所以采用python来提高效率。python跑一遍项目的har文件,按照har文件里的接口书写runAPI文档,并全局搜索项目文件中是否使用具体字段;

【问题】 目前使用了开放接口书写runAPI客户端的文档, 但是请求json格式不知道写成什么样,才可以被runAPI项目识别并且可以发起接口请求;

下方代码中page_content按照开放接口文档的意思是是说,只支持markdown或者html, 但是没说runAPI的格式应该是怎么样,所以希望star7th看到了之后给我指明方向. page_content的json格式怎么写,才可以被runAPI客户端识别

python代码

import requests
api_key = "xxx"  # api_key
api_token = "xxx"  # api_token
# 同步到的url。使用www.showdoc.com.cn的不需要修改,使用私有版的请修改
url = "http://xxx.com/server/index.php?s=/api/item/updateByApi"

headers = {
    "Content-Type": "application/json"
}

data = {
    "api_key": api_key,
    "api_token": api_token,
    "cat_name": '目录',
    "page_title": '接口',
    "page_content":{
        "title ": '123123',
        "catalog": " 测试文档/用户相关",
        "return": {"error_code": 0, "data": {"uid": "1", "username": "12154545", "name": "吴系挂", "groupid": 2, "reg_time": "1436864169", "last_login_time": "0"}}
    },
    "s_number": None,
    "page_return": {"error_code": 0, "data": {"uid": "1", "username": "12154545", "name": "吴系挂", "groupid": 2, "reg_time": "1436864169", "last_login_time": "0"}}

   }

response = requests.post(url, headers=headers, json=data)
print(response.status_code)
print(response.json())

顺颂商祺,开发无bug

回答

0

这个格式可能是会变的。我不想有开发者写程序依赖到此格式,会给我以后的维护带来麻烦。我不想带上向后兼容的包袱。

9

好的谢谢,我这边再看看怎么处理比较妥当