深圳YouNeedBoy组-萝卜多-接口文档

1./u表示登陆才能访问

2.rest风格接口

3.所有的返回字段都包含code和message，code表示状态码，message表示状态信息。

前台接口：

1.获取职位信息：

请求地址：/get /a/profession

请求参数：

字段	说明	类型	是否必填	备注
page	页码	number	是
size	展示数量	number	是

返回参数：

data

2.职位查找：

请求地址：get /a/profession/search

请求参数：

返回参数：

data

由于接口文档好多，这里我就不截取了。

写接口文档的时候发现了好些问题，在这里总结一下：

1.和我的另外一个后端小伙伴没有沟通好，职位和公司这两个接口我们的部分字段没有保持一致，比如：公司地区，他只写了一个字段city，我分为了两个字段province和city。

2.我在第一遍写接口文档的时候，没有考虑到分页查询的情况，这个page和size需要添加。

3.每个公司有好多职位，每个职位对应好多公司，这个应该创建关联表，这个没有做过，要学习一下。

4.公司有公司产品，我们暂时是把产品放在公司表里面，这样就造成了公司表的字段特别多，比较冗余，打算把公司产品单独提取出来，做一个表格。

5.后台模块部分，经过讨论，暂时定为，大模块有父模块ID，父模块下面的小模块有子模块ID。