接口封装统一返回格式

本文介绍了如何在接口中封装统一的返回格式,包括单条数据、多条数据和分页数据的处理方式。在定义篇中,详细阐述了返回编码和信息的枚举类设计,以及统一返回格式的规范。在封装数据篇中,展示了具体的数据封装实践,包括单条、多条及分页数据的封装结果。
摘要由CSDN通过智能技术生成


【统一返回格式】

【1】单条数据

{
   
	"code": "200",
	"msg": "成功",
	"sign": "",
	"data": {
   
		"name": "tom",
		"id": "1"
	}
}

【2】多条数据

{
   
	"code": "200",
	"msg": "成功",
	"sign": "",
	"data": [
		{
   
			"name": "tom",
			"id": "1"
		},
		{
   
			"name": "jack",
			"id": "2"
		}
	]
}

【3】多条分页数据

{
   
	"code": "200",
	"msg": "成功",
	"sign": "",
	"data": {
   
		"total": "2",
		"rows": [
			{
   
				"name": "tom",
				"id": "1"
			},
			{
   
				"name": "jack",
				"id": "2"
			}
		]
	}
}

【定义篇】

【1】定义:返回编码和信息(使用枚举类)

package com.ssm.common.enums;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;

import java.util.Objects;

@Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public enum CodeEnum {
   
    
    OK("200", "成功"),
    VALUE_NULL("300", "值为空"),
    PARAM_NULL("301", "参数为空,处理异常&
  • 1
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
在 Python 中,可以封装一个统一格式的 HTTP 请求接口,以便在不同的项目中使用。以下是一个示例代码: ```python import requests import json def http_request(url, method='GET', headers={}, params={}, data={}): try: response = requests.request(method=method, url=url, headers=headers, params=params, data=data) response.raise_for_status() except requests.exceptions.HTTPError as error: return {'error': error} except requests.exceptions.ConnectionError as error: return {'error': error} except requests.exceptions.Timeout as error: return {'error': error} except requests.exceptions.RequestException as error: return {'error': error} content_type = response.headers.get('content-type') if 'application/json' in content_type: result = json.loads(response.text) else: result = response.text return {'result': result} ``` 以上代码定义了一个 `http_request` 函数,该函数接收 `url`、`method`、`headers`、`params` 和 `data` 等参数,用于发送 HTTP 请求并返回统一格式的结果。如果请求失败,将返回包含错误信息的字典。 可以使用以下代码示例使用 `http_request` 函数: ```python url = 'https://www.example.com/api/v1/users' headers = {'Authorization': 'Bearer xxxxxxxx'} params = {'page': 1, 'limit': 10} response = http_request(url, method='GET', headers=headers, params=params) if 'error' in response: print(response['error']) else: print(response['result']) ``` 以上代码示例用于发送一个 GET 请求,并使用 Bearer Token 鉴权方式。如果请求成功,将返回 API 的响应结果。如果请求失败,将打印错误信息。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值