美文网首页
前后端webapi格式约定

前后端webapi格式约定

作者: yaoshiyou | 来源:发表于2016-06-30 12:41 被阅读131次

    基本约定

    get 获取返回对象或列表,列表返回使用复数
    post 对象存在返回500异常
    StatusCode :200 OK
    StatusCode :500 错误 通过error.Message获取错误详情
    测试基地址:http://dev.xx.com/{项目名称简写}
    正式基地址:http://eas.xx.com/{项目名称简写}
    示例:
    http://dev.xx.com/qwx
    http://eas.xx.com/qwx

    地址约定

    / 不需要登录的页面
    /index 需要登录的页面
    /weixin 微信
    /app app页面引导
    /rest WebApi接口地址

    单对多对象

    decl 申报主单
    goods 申报货物详情(一个申报单有多个货物)
    config 公共配置

    decl主单

    列表

    get url:/rest/decl?page=1&size=10
    返回:[] 分页在头部

    批量创建

    post url:/rest/decl/batch
    body:[]
    返回:void

    创建+更新

    post url:/rest/decl/{Id}
    body:{}

    id为空为新增
    id=123 为更新
    返回:{}

    状态修改(标记查验)

    post url:/decl/{id}/check
    返回:{}

    删除

    post url:/decl/{id}/delete
    返回 200

    货物good

    单个对象

    get url:/decl/{declId}/goods/{goodId}

    列表

    get url:/delc/{declId}/goods?page=1&字段=值
    返回:[]

    字段名与数据库一致

    创建

    post url:/decl/{declId}/goods/
    body:{}

    修改保存

    put url:/decl/{declId}/goods/{goodId}/baseinfo
    body:{}

    baseinfo 修改基本信息

    简单修改-单条标记查验

    post url:/decl/{declId}/goods/{goodId}/check

    check 简单修改

    状态修改-批量标记查验

    post url:/decl/{declId}/good/checks?ids=aa,bb,cc

    状态修改-批量结果登记

    post url:/decl/{declId}/good/result
    body:[]

    body为goods对象列表

    删除

    post url:/decl/{declId}/good/{goodId}/delete

    config

    org机构

    get url:/config/orgs?name=宁波

    dept部门

    get url:/config/org/{orgId}/depts

    部门人员

    get url:/config/org/{orgId}/dept/{deptId}/users

    人员列表

    get url:/config/users?orgId=aa&&deptId=bb

    dock码头

    get url:/config/docks
    response:[]

    berth泊位

    get url:/config/dock/{dockId}/berths
    response:[]

    get

    #多对多对象

    对象

    user
    role
    resource

    uer

    /user?role=
    /user/{userId}/role

    role

    /role?userId=
    /role/{roleId}/user
    /role/{roleId}/user/{userId}

    相关文章

      网友评论

          本文标题:前后端webapi格式约定

          本文链接:https://www.haomeiwen.com/subject/xcaxjttx.html