发表于: 2020-12-27 23:42:25

1 1331


今天完成的事情:
数据库设计
明天计划的事情:
接口文档设计
遇到的问题:
以下
收获
后台原型图



=================================
思维导图




=============
八张表:
user表:用户表
banner表:作为放banner图片表
stair_headline表:存放一级标题
classify表:二级标题分类表
work表:存放作品
comment表:评论表
reply表:回复表
studio表:存放工作室信息
=========================================
数据库建立
user表


banner表
stair_headline表
classify表



work表



comment表



reply表



studio表




简单了解如何写接口文档


一、什么是接口文档?

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


二、为什么要写接口文档?
1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2、项目维护中或者项目人员更迭,方便后期人员查看、维护


三、接口规范是什么?
首先接口分为四部分:方法、uri、请求参数、返回参数

1、方法:新增(post) 修改(put) 删除(delete) 获取(get)


2、uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;中间一般放表名或者能表达这个接口的单词;get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以st结尾;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地址里不允许出现大写字母,如果是两个单词拼接,用 _ 分开



返回列表 返回列表
评论

    分享到