更新文档

This commit is contained in:
wojiaoyishang
2025-01-27 19:48:27 +08:00
parent 155af93c77
commit 5153daf7da
39 changed files with 767 additions and 593 deletions
+21 -1
View File
@@ -1,7 +1,9 @@
.. _JSON 响应正文生成模块:
:mod:`http` -- JSON 响应正文生成模块
=======================================
:mod:`http` 模块源代码在文件 `applications/common/utils/http.py` 下,主要用于生成 JSON 格式的响应正文。
:mod:`http` 模块源代码在文件 `applications/common/utils/http.py` 下,主要用于生成 JSON 格式的响应正文。
对于大部分 JSON 格式响应的数据,请尽量遵循响应格式规范。如此方便后续前后端的分离和项目的构建。
@@ -36,4 +38,22 @@
:param limit: 每页数据条数,默认为 10。
:return: 返回 JSON 格式的响应,包含 `msg`、`code`、`data`、`count` 和 `limit` 字段。
**示例:**
.. code-block:: python
from applications.common.utils.http import success_api, fail_api
@bp.get('/init')
def init():
if ...:
return success_api(msg="初始化成功")
return fail_api(msg="初始化失败")
.. code-block:: python
from applications.common.utils.http import table_api
@bp.get('/data')
def data():
return table_api(data=[], total=0)