前后端webapi格式约定

基本约定

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}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,657评论 18 139
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,430评论 0 19
  • 邮检管理 主表 提交主表 url:/pos/rest/ptdecl/{id} method:post reques...
    sunshine_hao阅读 1,000评论 0 1
  • 主表 提交主表 url:/nap/rest/decl/{id} method:post request:NAP_D...
    sunshine_hao阅读 539评论 0 0
  • 《裕语言》速成开发手册3.0 官方用户交流:iApp开发交流(1) 239547050iApp开发交流(2) 10...
    叶染柒丶阅读 26,765评论 5 19