python怎么封装api response
时间: 2023-08-07 22:00:30 浏览: 128
在Python中,封装API响应可以通过定义一个类来实现。以下是一个示例:
```python
class ApiResponse:
def __init__(self, success=False, data=None, error=None):
self.success = success # 标记请求是否成功
self.data = data # 存储响应数据
self.error = error # 存储错误信息
def to_dict(self):
return {
'success': self.success,
'data': self.data,
'error': self.error
}
```
在上面的代码中,我们定义了一个名为`ApiResponse`的类。该类有三个属性:`success`(标记请求是否成功的布尔值)、`data`(存储响应数据的任意类型)和`error`(存储错误信息的字符串)。此外,类中还定义了一个`to_dict()`方法,用于将类的实例转为字典形式,方便后续转换为JSON。
使用时,我们可以创建一个`ApiResponse`对象,并传入相应的参数,例如:
```python
response = ApiResponse(success=True, data={'id': 1, 'name': 'John'}, error=None)
```
这将创建一个`ApiResponse`对象,其中`success`属性为`True`,`data`属性为一个包含id和name的字典,`error`属性为空。
要获取响应数据,可以通过访问对象的属性来实现,例如:
```python
print(response.data) # 输出:{'id': 1, 'name': 'John'}
```
我们还可以将`ApiResponse`对象转换为字典形式,方便后续进行JSON序列化:
```python
response_dict = response.to_dict()
```
最后,我们可以使用任何适合的方式将`response_dict`转为JSON字符串,用于API响应。
阅读全文