但丁云 接口规范

927 阅读1分钟

网关规范

  1. 接口统一走网关,所有系统接口,统一登陆
  2. 接口环境 测试环境:yang800.cn , 线上环境 yang800.com

request 规范

	method : 'POST',
    data : JSON ,
    headers: {
		Content-Type : 'application/json' ,
        //当前时间
        timestamp: timestamp,
        //业务系统ID
        clientId: clientId,
        //`clientId${clientId}data${str1}path${'/ucenter-admin/login'}timestamp${timestamp}version${'1.0.0'}${clientSecret}`做md5转大写
        sign: sign
	}

response 规范

	{	
    	code : 200,
        data : {} || [],
        message : ''
    }

code 取值范围

  • 200 : 成功
  • -1000 ~ -1999 : 权限相关,-1001:未登陆,-1002:没有权限
  • -2000 ~ -2999 : 网关错误
  • -1 ~ -999 :业务相关只需要弹出服务端错误码,无需前端进行其它处理的错误
  • > 200 : 业务相关,且需要前端处理的错误

配置中心相关

select 数据源,包括select多选

	{
    	code : 200,
        data : [{
        	id : '',
            name : ''
        }]
    }

级联数据

	{
    	code : 200,
        data : [{
        	id : '',
            name : '',
            list : [{
            	id : '' ,
                name : '',
                list : [{
                	id : '' ,
                    name : ''
                }]
            }]
        }]
    }

列表查询

查询 /xhr/good-list

	//request
	{
    	currentPage ,
        pageSize , 
        key1 : '',
        key2 : '',
        key3 : [] 
    }
    // response
    {
    	dataList : [],
        page : {
			currentPage , 
            pageSize , 
            totalCount , 
            totalPage 
		}
    }

导出excel数据

导出excel数据的接口,参数跟查询一模一样,只在接口请求地址后面加上/download``${url}/download 下载 /xhr/good-list/download ,参数同查询

导入excel数据

由于网关接口,只支持 application/json 无法支持form-data格式,因此,所有的上传,由前端先上传到oss服务器上,然后将文件url进行提交

导入excel数据的接口,只在接口请求地址后面加上/upload``${url}/upload,参数为:file:url