发表于: 2017-06-20 23:32:07
1 1251
今天完成的事情:
昨天将接口写完,今天和前台对了对接口,,商量好了那几个接口是需要加上请求参数的,但是我总有中我写的接口文档有问题的感觉,准备做过复盘的师兄的看看,哪里有学要修改的地方,但是说感觉大家度比较忙,今天就在wiki上看大家其他项目的接口文档是怎么写的,由于页面不一样,所以接口文档也不一样。
今天下午老大评我日报了,提醒我接口文档中的字段命名不合理,关键字一般看你搜索的内容是什么,是Titlehai还是Content。不知道的话可以叫Content。我之前参照他们做其他项目的接口文档,写的请求参数,套用过来发现不合理。


今天还将接口文档的目录列出来,理一下思路。
前台接口
首页
获取最新职位logo列表 接口 GET /home
请求参数
返回参数
推荐职位/最新职位
获取最新职位列表 接口 GET /jobList
请求参数
返回参数
找职位
找职位页
获取推荐职位/最新职位列表 接口 GET /findJob
请求参数
返回参数
搜索公司页 /searchCompany
请求参数
返回参数
公司详情 接口 GET /companyHome/{id}
请求参数
返回参数
公司在招职位页 接口 GET /findingJobs
返回值
职位介绍 接口 GET /jobIntroduce/{id}
返回值
搜索职位页 接口 GET /searchJob
请求参数
返回参数
找精英
找精英 接口 GET /findElites
返回参数
公司列表页 接口 GET /companyList
请求参数
返会参数
关于我们
关于我们/联系我们 接口 GET /aboutUs
明天计划的事情:
找大佬帮我看看接口文档,修改好了开始写方案设计。
遇到的问题:
上面提到了
收获:
第一次跟前端商量关于项目的事情,发现一个项目开发的过程需要前后台,各个模块的人员来共同协作完成,这个过程,学到的东西真的很多。
评论