[北京|荣耀师兄]JAVA-杨舜|2017年07月12日的日报-技能树.IT修真院

发表于： 2017-07-12 12:57:51

1 1421

今日完成：

看了萝卜多复盘项目的视频讲解

完成昨天剩余的表结构设计，但是感觉设计的不够好

了解了什么是接口文档、为什么要设计接口文档

明日计划：

把表结构设计好

写首页的接口文档

收获：

公司表

COLUMN	JAVA FIELD	TYPE	JAVA FIELD TYPE	NOT NULL	COMMENT	PRIMARY KEY
id	id	BIGINT	Long	NOT NULL	自增id
c_id	cId	BIGINT	Long	NOT NULL	公司id	PRIMARY KEY
company_name	companyName	VARCHAR	String	NOT NULL	公司名称
company_number	companyNumber	VARCHAR	String	NOT NULL	公司人数
trade	trade	VARCHAR	String	NOT NULL	公司行业
city	city	VARCHAR	String	NOT NULL	所在城市
size	size	VARCHAR	String	NOT NULL	公司规模
authentication	authentication	VARCHAR	String	NOT NULL	认证状态
freeze	freeze	VARCHAR	String	NOT NULL	冻结状态
slogan	slogan	VARCHAR	String	NOT NULL	公司标语
tag	tag	VARCHAR	String	NOT NULL	公司标签
company_introduction	introduction	VARCHAR	String	NOT NULL	公司介绍
product_id	pId	BIGINT	Long	NOT NULL	公司产品id
phone	phone	INT	int	NOT NULL	公司电话
address	address	VARCHAR	String	NOT NULL	公司地址
mail	mail	VARCHAR	String	NOT NULL	公司邮箱
map	map	VARCHAR	String	NOT NULL	公司地图
profession_id	proId	BIGINT	String	NOT NULL	公司招聘职业id

职业表

表字段						备注	字段约定
COLUMN	JAVA FIELD	TYPE	JAVA FIELD TYPE	NOT NULL	PRIMARY KEY	COMMENT
id	id	BIGINT	Long	NOT NULL	PRIMARY KEY	自增id
profession_id	proId	BIGINT	Long	NOT NULL		职业id
p_name	pName	VARCHAR	String	NOT NULL		职业名称
c_id	cId	BIGINT	Long	NOT NULL		公司id
pay	pay	VARCHAR	String	NOT NULL		薪资
education	education	VARCHAR	String	NOT NULL		学历
work_experience	workExperience	VARCHAR	String	NOT NULL		工作经验
release_time	releaseTime	BIGINT	Long	NOT NULL		发布时间
stutas	stutas	VARCHAR	String	NOT NULL		状态

一、什么是接口文档？
在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

二、为什么要写接口文档？
1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭，方便后期人员查看、维护

三、接口规范是什么？
首先接口分为四部分：方法、uri、请求参数、返回参数
1、方法:新增(post) 修改(put) 删除(delete) 获取(get)
2、uri：以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。
3、请求参数和返回参数，都分为5列：字段、说明、类型、备注、是否必填
字段是类的属性；说明是中文释义；类型是属性类型，只有String、Number、Object、Array四种类型；备注是一些解释，或者可以写一下例子，比如负责json结构的情况，最好写上例子，好让前端能更好理解；是否必填是字段的是否必填。
4、返回参数结构有几种情况：1、如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；2、如果要返回某些参数，则有两个结构体：1是code/mesage/data，2是data里写返回的参数,data是object类型；3、如果要返回列表，那么有三个结构体，1是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list里放object，object里是具体的参数。

注意：uri地址里不允许出现大写字母，如果是两个单词拼接，用/分开

问题：

前端还是没有新学员做复盘项目