一个python包，它将各种语言的apidoc注释转换为OpenApi Spec.json文件。
apidoc-to-openapi的Python项目详细描述
Apidoc到Openapi转换器
Apidoc语法非常简单和轻量级，而Openapi aka Swagger语法非常冗长，对noob不友好。这个项目的目标是使编写api端点的文档变得非常容易，开发人员不会介意花时间去做，而不是忽略文档。在
Apidoc转换范围
可转换批注：
@api
@apiName
@apiGroup
@apiParam
@apiSuccess
在任何其他公关需要你觉得自由。在
安装
^{pr2}$usage: apidoc_to_openapi [-h] -i path [-o path] [--yaml]
optional arguments:
-h, --help show this help message and exit
-o path File output (default: stdout)
--yaml Convert output to yaml format
Required:
-i path File or directory containing apidoc annotations
示例
apidoc-to-openapi -i ./my/path/ -o ./my/path/swagger.yaml --yaml
运行测试
使用pytest进行测试。测试覆盖率没有达到我想要的水平。在
编码方式
使用黑色格式化程序和pylint
作者
- ^{1$首字母
许可证
这个项目是在MIT许可下授权的-请参阅LICENSE.md文件了解详细信息
致谢
- 我没有朋友
- 项目
标签：
欢迎加入QQ群-->： 979659372
