接口如何设计?

get:查询,单条记录,列表

post::新建资源。(新增订单)

put:更新(全量更新)

patch:更新(局部更新)

delete:删除

应用添加
path:/app
method:post
请求参数:
{
    "enAppName":"英文应用名称",
    "chAppName":"中文应用名称",
    "operator":"操作人",
    "dataSourceType":"1",
}
返回参数:
{
    "code":0,
    "message":"消息内容",
    "data":{}
}

应用修改
path:/app
method:put
请求参数:
{
    "appId":"uuid",//新增不填,修改必填
    "enAppName":"英文应用名称",
    "chAppName":"中文应用名称",
    "operator":"操作人"
}
返回参数:
{
    "code":0,
    "message":"消息内容",
    "data":{}
}

应用修改(局部)
path:/app/{appId}
method:patch
请求参数:
{
    "chAppName":"中文应用名称",
}
返回参数:
{
    "code":0,
    "message":"消息内容",
    "data":{}
}

应用删除
path:/app/{appId}
method:delete
请求参数:

返回参数:
{
    "code":0,
    "message":"消息内容",
    "data":{}
}

应用列表
path:/app/list?pageNumber=1&pageSize=10&queryStr=查询条件&sortrule=+a字段,-b字段
method:get

返回参数:
{
    "code":0,
    "message":"消息内容",
    "data":{
        "list":[
            {
                "appId":"uuid",
                "enAppName":"英文应用名称",
                "chAppName":"中文应用名称",
                "dataSourceType":"1",
                "operator":"操作人",
                
                "createTime":毫秒长整型,
                "updateTime":毫秒长整型
            },
            {
                "appId":"uuid",
                "enAppName":"英文应用名称",
                "chAppName":"中文应用名称",
                "dataSourceType":"1",
                "operator":"操作人",
                
                "createTime":毫秒长整型,
                "updateTime":毫秒长整型                
            }
        ],
        "pageNumber":1,//第几页,从1开始。
        "pageSize":10,//页面大小    
        "totalRecord":100,//总数
    }
}

应用详情
path:/app/{appId}
method:get

返回参数:
{
    "code":0,
    "message":"消息内容",
    "data":{
                "appId":"uuid",
                "enAppName":"英文应用名称",
                "chAppName":"中文应用名称",
                "dataSourceType":"1",
                "operator":"操作人",
                "createTime":毫秒长整型,
                "upateTime":毫秒长整型
        }
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值