与数据库配置界面相识,左边可以显示所有配置的接口列表。
中间是对应的接口可视化配置信息。
右边是最终生成之后的代码。包括后端接口代码与前端api调用接口的代码。
顶部几个按钮可以选择数据库来快速生成增删改查分页接口。也可以保存,删除,更新接口。
视频教程如下
选择对应数据库表之后,右边有五个按钮,分别对应的新增接口,更新接口,单条数据查询接口,分页查询接口以及删除接口。如下图
点击完之后会自动生成可视化配置结构,自动生成接口代码与api调用代码。
前端一键生成增删改查分页,也是选择数据库之后自动调用这些接口。
当然生成代码之后大家也可以可视化的去修改接口。
点击”复制“按钮即可快速复制当前所选的接口。
配置好接口之后点击生成代码
右边会自动看到生成好的接口代码与api调用接口的代码。
点击”插入后端后端接口代码“即可自动将代码插入到对应的文件中并且会自动保存。
也就是后端的控制器/servers/app/controller
以及后端的路由配置/servers/router
点击”插入前端api代码“则会自动将封装好的接口调用方法插入到/src/api中。
从而我们在前端调用接口的时候就简单很多,只需要一键插入即可搞定。
如果想从零开始配置,或者想将配置好的接口清空掉。
则可以点击”重置“按钮。
如果是不小心点击了”重置“按钮也没关系,不要点击保存,也不要点击插入代码。
切换其他接口配置即可自动恢复。(也就是没有保存即可自动恢复)
保存接口配置是线上存储你的配置,也就是下次再进来可以继续可视化配置接口。
插入代码到本地文件时会自动线上保存。
删除接口要注意如下图,红色的删除按钮则表示删除掉该接口。
并且会将后端接口配置,接口地址,api代码都会删除的一干二净。
而左边的蓝色背景的删除按钮,其实快速新增一个删除接口。注意区分
我们最常遇到的情况就是需求的变更,其中最少不了的就是字段的变更。
如果数据库表中添加或删除了一些字段,那我们的接口也需要添加或删除对应的字段。
这样我们还得手动一个个去改接口。特别是新增接口与更新接口。
而这个一键更新接口,则是选择对应的数据库表之后,会自动将当前的接口添加或删除对应的字段。
比如创建用户表的时候,只有username与password表。但后续后添加了age表。
而我们的更新用户表接口与新增用户表接口也需要添加age字段,一键更新的话就会自动给你添加好。
基本配置如下
也就是后端控制器封装的方法名称,与api接口调用封装的名称。
命名规则为查询类型 + 方法名称。
如该接口查询单条数据,生成的方法名称为findOneArticle
接口名称则用来描述接口的作用。
生成的代码会自动形成注释,如上图的article-查询 就是代码注释。
这样那么后续二次开发也能很清楚的看懂接口代码。
请求方式目前只支持get请求与post请求。后续可能会开发socket,delete等。
项目类型可分为element后台、art-template前台、uniapp移动端接口。
生成的预览地址也会不同。
路由配置文件也不同。
返回的内容也不同。
element后台:配置好接口地址之后,真实地址会自动添加admin前缀,
通常用于element后台对接口的调用,返回的则是json格式的数据。
art-template前台模板:则没有任何前缀。并且会多出一个选项,可以选择静态模板页面。
也就是/servers/view里的html页面。
比如
并且生成的代码返回的是带有数据的静态页面,而不是json数据结构。
通常用于做简单的cms企业建站等展示类型的前台页面。
uniapp移动接口:可以配置uniapp相关的接口,接口地址配置好之后,实际接口地址也会自带app前缀如下图
参数配置与数据库里的参数配置类似,输入参数字段名空格隔开,即可自动生成相关的参数配置如下图。
由于有些接口是需要登录才能看到的,有些接口又不需要登录,
还有些接口登录之后只能查看到自己的信息。
所以我们添加了登录判断功能。如下图
无需登录则表示该接口任何人都能访问,不需要登录也可以访问。
则表示该接口必须登录之后才能看到。这里只做了登录的判断,所以只要是登录过的用户都可以调用该接口。
则表示该接口不仅需要登录,而且还会根据登录之后的用户信息,
也就是将用户id也作为一个查询条件来查询数据。
用户调用接口只能查看自己的数据,不能看到其他用户的数据。
新增接口多用于保存数据到数据库中,点击”增“按钮,则生成的代码会根据数据库表来自动生成新增接口。
代码如下:
where则会要新增的字段。
可视化接口配置中最底部有个数据库名称,也就是对应的表名称。
输入名称之后生成的代码会自动对该表进行保存数据操作。
新增接口中这块则对应的是要插入表的字段有那些。
要插入那些字段则勾选那些字段,
where条件里则自动添加这些字段。
因为有的参数并不需要插入到数据库中,比如分页条数与页码。
如果这条数据需要用户id来识别到底是谁添加的,
则可以将登录类型选择为"登录之后使用id"
这样生成之后的代码自动添加userId字段
最后我们就可以很清楚该数据是那个用户添加的,
后续用户也可能根据这个字段来查询自己的数据。
用于对以添加好的数据进行修改操作。
与新增接口类似但多了一些条件查询字段。
点击接口类型按钮组里的"改"按钮,根据输入的数据表自动生成的代码如下
其中where则是要更新的数据条件查询,updateParams则是要更新的字段。
在可视化接口配置最底部可以看到如下图,
除了查询条件以外还多了一个要更新的字段选项。
查询条件则是根据条件查询要更新的数据,多用_id来作为条件。
如果这个更新接口需要登录并且只能修改自己的数据,
则可继续勾选“登录之后使用id”来额外添加一个条件。
要更新那些字段则在“要更新字段”下方勾选即可。
生成代码如下
有很多字段是不支持用户自己去修改的,比如用户的余额需要充值才可自动更新。
所以要控制好权限。
删除接口用于对数据进行删除操作。
删除接口与新增接口配置类似。
最底部的条件查询则表示要删除的条件。
多用于_id作为条件来进行删除,
如果数据只能登录过的用户才可删除,则可选择登录方式为“添加登录判断”
如果用户只能删除自己的数据则可以添加一个条件“登录后使用id”。
分页查询多用于对数据太多进行一个分段查询,
分页组件也可以通过该接口查询对应的数据。
选择条件查询,右边会自动出现条件代码。
可以自己配置分页条件,
limit则表示显示条数通常是十条数据。
start起始位置,第一页的数据起始位置为0,从0开始查询10条数据。
第二页则是从10开始查询10后面的10条数据。
sort则表示排序条件
createTime则表示按创建时间来进行排序,-1与1表示递增与递减
也可以改为其他字段比如sortNum自定义排序,price按价格进行排序。
更多的配置可以查询mongodb文档
与之前的接口查询类似,可勾选条件来进行查询
查询的数据默认会返回所有数据,但有些内容是需要保密的只能管理员才能看,也有些内容数据量很大。
比如文章的内容,如果查询了十条数据把内容全都返回给前端,则会导致数据发送量庞大慢等问题。
所以我们需要过滤一些字段。
比如过滤密码,则只需勾选上图的password,这样查询的数据就不会返回password数据。
单条数据查询多用于查询详细,也就是所有数据。
比如文章列表进入到文章详情页面,则只需根据文章id查询详细信息。
按钮组里点击“查”,则会根据条件查询单条数据的详细信息。
如果多条数据都满足同一个条件则会选择第一条数据作为查询结果。
比如查询条件为文章名称,如果出现名称相同的多篇文章,
则只会将第一篇文章的详细信息返回。
与单条数据查询一样,但返回结果不同。
单条数据返回的是数据详细信息,也就是就是对象。
而多条查询之后的结果会存放在数组中。
与分页查询不同的是,这里会查询所有满足添加的结果,
也就是有多少条就显示多少条,并不会分页。
多表查询我们后端用的node环境,所以支持异步。
所以我们的多表查询可以封装好其他表的查询方法。
如下图点击创建
弹出对数据库表的各种增删改查操作配置
配置好之后点击生成代码。
这样一个查询方法就自动生成了
其他地方如果要使用的话,
只需要 let installData = await isInstall() 即可将获取到的数据存储到installData变量中。
除了可视化配置各种参数条件以外,难免有一些条件需要自定义,
所以我们支持手写代码嵌套。
在自定义条件里可以插入自己的条件代码如下图
更新条件自动将创建时间与更新时间字段的值设置为当前时间。
模糊查询也就是关键字查询,
mongodb里的其实只需要利用好正则表达式即可。
如果不会写也可以选择好参数之后点击"模糊查询正则"按钮即可自动生成代码
比如选择用户名称自动进行关键字查询,生成代码如下
这样我们只需通过关键字即可查询相关的数据。
如果需要多个字段也进行关键字查询可以点击“多字段查询或”
生成代码如下
然后将代码简单修改以下,比如上图重复的username,可以改为其他字段,如title。
也可以按照这个格式添加多个,让多个字段也支持关键字查询。
比如查询昨天的数据,查询点赞数大于100的数据,大于年龄小于18的数据等。
代码如下:
where.age = {$lt:18}
更多的条件也可以看mongodb基础文档
具体可看视频教程。