自动生成用于APIDOC的api注释

2024-10-02 10:25:02 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在创建API文档,并决定使用APIDOC(https://apidocjs.com/)生成文档。我想知道是否有一个工具可以从我的python api文件自动生成内联文档注释

这是我希望为我生成的结果:

"""
@api {get} /user/:id Request User information
@apiName GetUser
@apiGroup User

@apiParam {Number} id Users unique ID.

@apiSuccess {String} firstname Firstname of the User.
@apiSuccess {String} lastname  Lastname of the User.
"""

Tags: 文件工具ofthe文档httpscomapi

热门问题