除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

开头先声明,这不是广告,不是广告,不是广告,没有恰饭。

本人在公司开发的时候,由于使用的框架还是SSM,对接Swagger相当麻烦,但又不能不写接口文档吧?所以只能跑去问问度娘了。

我:“度娘度娘,谁是这世界上最好用的接口文档呢?”

度娘:“那当然是ShowDoc啦!”

这个接口文档网站是我无意间发现的,真的巨好用,注册简单,使用方便,重要的是还免费,这上哪找去?缺点就是纯手写,不过短期应付也还好,对于懒的兄弟,也有模板提供,没有用Swagger的兄弟应付应付前端也还是可以的(手动狗头,前端兄弟开个玩笑)

废话不多说,进入正题:

1.进入网址

官方地址:https://www.showdoc.cc/
首先肯定是要注册的,只需要邮箱即可。
注册完成登录后,右上角有一个我的项目,点击即可达到我的项目页面。
在这里插入图片描述

2.我的项目

进入到我的项目页面,就可以创建自己的项目了,前3个是自带的,最后一个叫qs的项目就是我自己创建的了
在这里插入图片描述

3.新建项目

这里就不用我多说了吧?
在这里插入图片描述

4.新建项目的团队

项目建好后,就可以把你们项目组的人都拉进来了,前提是他们先要注册好。

1.点击团队管理
在这里插入图片描述
2.就可以看到我的团队了,然后添加团队
在这里插入图片描述
3.点击某个团队的成员,就可以添加成员了,把自己的同事都拉进来吧。不过好像是有上限的,我忘记是几个了,不过拉开发人员应该足够了
在这里插入图片描述

5.为团队分配一个项目

把刚刚新建的团队分配一个项目,那么该团队的人都可以看到这个项目了
在团队管理页面,点击项目就可以进入这个界面了
在这里插入图片描述

6.新建一个接口文档

回到我的项目页面,点击该项目,就可以进到项目的文档页了在这里插入图片描述
然后点击新建文档,可以选择该文档的目录,然后接口文档的模板就是点击插入API接口模板即可,然后就可以开始写文档啦
在这里插入图片描述
该接口文档的教程就到此了,感谢大家的观看,应该没有什么难懂的地方吧?

本人第一篇文章,处女作,有写的不好地方还望各位口下别留情面,使劲喷就完事了,接受批评,希望后面越来越好。

作者公众号(欢迎关注,分享的全是干货!!!):
在这里插入图片描述

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger 接口文档可以用于自动生成接口测试的 YAML 文件,具体步骤如下: 1. 在 Swagger UI 中找到要测试的接口,并点击 "Try it out" 按钮。 2. 填测试需要的参数,并点击 "Execute" 按钮。 3. 点击 "Code" 按钮,选择 "Shell"。 4. 复制代码,并粘贴到一个文本编辑器中保存为 YAML 文件。 YAML 文件中包含了测试所需的请求参数、请求方法、请求头等信息,可以通过自动化测试工具读取并执行测试。 示例代码如下: ```python import requests import yaml # Swagger 文档地址 SWAGGER_URL = 'http://your.swagger.host/swagger.json' # 发送 GET 请求,获取 Swagger 文档 response = requests.get(SWAGGER_URL) # 解析 Swagger 文档中的接口信息 if response.status_code == 200: swagger_doc = response.json() paths = swagger_doc.get('paths', {}) for path, methods in paths.items(): for method, info in methods.items(): # 获取接口的 URL url = f'{SWAGGER_URL.rstrip("/")}{path}' # 获取接口的请求方法 http_method = method.upper() # 获取接口的请求参数 parameters = info.get('parameters', []) # 获取接口的请求头部信息 headers = {} if 'headers' in info: for header in info['headers']: headers[header['name']] = header['description'] # 构造测试用例 test_case = { 'name': f'{http_method} {url}', 'request': { 'url': url, 'method': http_method, 'headers': headers, 'params': {} } } # 将请求参数添加到测试用例中 if parameters: for param in parameters: if 'name' in param: test_case['request']['params'][param['name']] = param.get('example') # 将测试用例转换为 YAML 格式并输出到文件中 with open(f'{http_method}_{path.replace("/", "_")}.yml', 'w') as f: yaml.dump(test_case, f, default_flow_style=False) else: print(f'Failed to get Swagger document. Status code: {response.status_code}') ``` 在上述代码中,我们使用 `requests` 库向 Swagger 文档的 URL 发送 GET 请求,获取 Swagger 文档的 JSON 数据。然后,解析 JSON 数据,获取每个接口的 URL、请求方法、请求参数和请求头信息等信息。最后,根据接口信息构造测试用例,并将测试用例转换为 YAML 格式并输出到文件中。你可以根据需要对测试用例进行扩展和优化。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值