Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

接口文档完整样例 #1

Closed
cabbage217 opened this issue Mar 24, 2020 · 1 comment
Closed

接口文档完整样例 #1

cabbage217 opened this issue Mar 24, 2020 · 1 comment

Comments

@cabbage217
Copy link

你好,我要要一份接口文档的完整要样例,主要是对返回数据不知道怎么写文档。感谢。

@xuke1668
Copy link
Owner

src/api/base.py文件中举例的几个接口里都有注释,接口文档就是根据这些注释生成的。
src/doc.py文件里是具体的生成逻辑。

你想看看样例,可以直接运行该项目,然后访问一下接口文档的页面,比如http://127.0.0.1:5000/api/doc/,然后就能看到最终的文档样式。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants