轻松学会Laravel-项目篇(商城API) 12 项目前的准备 学习猿地原创

开始去写我们项目，在写项目之前，先进行项目前的一些准备。首先在我们的项目中去创建一些必要的文件夹和路由，去规范我们的项目。首先把之前的学习代码都删掉。把我们的测试路由也删掉。这个中间线留着我们去写的话，也有一些需要登录的路由。啊，这个VR就不要了。我们的项目有。前端啊，前台用的还有后端，就是后台使用的一些API，所以我们不可能把所有的API都放到这里面啊，这样的话去写。

就会比较乱，所以我们去复制这个，去新建一个其他的一个。文件，比如说啊，咱们去写我们后端相关的。API。然后我们还有一些登录啊，注册就是用用户认证相关的一些API，我们再建一个文件。啊，直接复制就可以了。啊叫also啊，这样的话，我们用户认证相关的API放到这里面，然后。啊，后台相关的放到这里面。前台用户，呃，使用的一些API放到这里面。那我们复制完文件之后呢，还要进行注册才可以使用在provide root service里面进行注册，把这我们新建的两个类文件注册进来。好，直接复制这个就可以。啊，改改名字。我先第一写第一个备注啊。

用户认证啊，相关路由这里就改成also。啊，这个我们用作啊钱财。没有。好，就是用API这个我们就是作为后台的一个路由，后台路由啊，改成我们的命，这样的话是我们把我们的路由啊进行了一个。啊，拆分各自放到各自的一个文件中，清楚吧。接下来。啊。这样的话，我们这几个文件都会被包含进去。就是注册到我们的路由中。接下来呢，我们对控制器啊进行一些创建，创建一个。啊的一个目录，用来放我们啊后台相关的一些路由，用来创建一个。

啊，外部的一个。文件夹用来放我们前台相关的路由啊控制器。再创建一个。Also啊，这个文件夹用来放用户认证相关的控制器。这样的话，我们对控制器也进行了一个分组。这时候做什么呢去？嗯，新建一个base controller。就是把我们之前在这里面去写的这个啊，柚子的这个订购API的这个har放到base control里面，这个controller我们尽可能的不去动它。下面创建一个控制器啊。在我们的虚拟机里面，虚拟机里面。我们的项目下PP。Make controller。Base controller。

创建完啊这个控制器之后，我们去调整一下这个控制器的一个内容。这里啊，多了一个控制器。哎，我们让这个控制器去。啊，使用。我们的这个。就是订购API提供的help啊在这里去写。那。这个里面的这个命名空间啊，就没有用了。删掉。好。这个时候我们让其他的控制器去继承这个base ctrl了啊，就不用继承原来这个CTRL，因为base ctrl已经继承了这个CTRL了，对吧。贝CTRL了。这些名人善良。这样我们的控制器也完成了一个分组。

API也完成了一个啊分组。好在我们进行。这一步之后。接下来干什么呢？啊，下载一个这个的客户端啊，之前我们推荐的是在这个呃，网页中去使用是吧。啊，如果你一直用浏览器的话也可以啊，但是更方便的话，还是去下载一个客户端可以更加能。使用方便一点啊，下载对应平台的就可以。已经下载完成啊，并且安装上之后会让你输入账号密码登录就可以了，看一下我们的这个项目。好，我们尝试去建一篇。啊，API的一个文档，这时候你会发现可以去使用它的模板，对吧，可以帮我们生成一个API的一个模板，但是这个模板并不完全去适合我们去使用，所以我们可以自定义我们的模板。行了吧。啊，怎么制定模板呢？就是你在这里去写你的模板就可以，写完好之后在这里可以另存为模板，现在我们要去制定两个模板，一个是我们的API模板，一个是我们的数据字典的模板，数据字典也就是我们数据库的啊这个表字的一个模板。

啊，这里我就不再一一去写。我从笔记里面去复制。先。啊，去粘贴一下。我们的这个API接口的这个模板啊，从这里开始。好到这里。这个就是我们将要用到的啊，API接口模板。首先是接口的一个描述，然后是请求的一个地址，请求的方式啊，接下来呢，是请求到这个头部的一个信息，如果没有头部可以去啊，忽略这一块的一个内容，接着是这个reset参数啊，也就是我们链接后面需要的这些路由参数，它的这个类型和作用是什么啊。

好。啊。如果没有的话，就是没有这个参数，这个也可以不写啊，但是我们模板的话，尽可能的去制定的全一些，方便我们去啊，适应各种我们的一个接口。啊，接着query查请求参数啊，这个请求参数一般是我们进行get查询的时候啊，就是附加到这个问号后面的这些参数，我们要在这里面进行说明是否必填吧，如果填的话是啊什么类型。有这么说明啊，这是query参数，然后是body请求参数，Body请求参数一般是我们进行啊post的表单，表单提交放到这个。啊，这个包里面的一些参数。如果你get的请求可能就没有包底请求参数，只有carry是吧，这个你就可以不要啊，都是这些啊，请求参数都是根据我们的实际的一个接口的情况去保留就可以了啊，接下来返回的一个参数，哎，就是。接口给我们返回的一个啊，参数一个名字啊，啊这里写错了，改成email。

啊，就是返回参数，它是都有什么意义，好，如果没有返回参数，比如一个无内容的一个响应啊，这个也可以不写，包括这个返回的事例，返回的事例呢啊，主要是把我们所有的状态码呢，可能这个情况给列举出来，比如说200的时候啊，是请求成功，包括我们返回的一些数据，把数据给列出来啊写一个事例啊，如果比如说201的时候，就是一个成功，没有什么啊这个内容是吧，比如说这个状态三二的时候，参数验证错误了，我们把这个错误信息啊给放上。溶血。啊，这API的文档的时候，一定把这个所有可能的一个结果，还有这个。啊，各个状态码表示的一个意义都写清楚。是吧，好，这样的话就是我们我们的一个模板啊，刚才有个地方写错了，把这个笔记也改一改。就是这里啊，返回到这个参数这里好。啊，我们模板建完之后呢，就可以啊，在这里去另存为模板。

啊，写上模板的名字，API接口模板，模板好保存就可以了。好，这个呢，就把它删掉了，接下来去创建一个什么模板呢？一个数据字典的一个模板，也就是我们数据库的一个模板，当然我们可以直接使用它的这个是吧，它这个就比较简单啊，然后啊，我们又对它增加了一些内容。就是比他的稍微再详细一些。就是这里啊，也放到了这里，大家复制就可以去使用了啊。主要增加了一个啊表明，然后一个表的一个描述，还有这个字段，每个字段代表的一个意义，还有就是说是否有备注。这个时候我们也可以去保存一个模板，另存为模板。是我们的数据字典啊，模板好，这样的话我们两个模板就创建完成了，那怎么使用呢？就当我们要使用自己这个模板的时候，就是在更多模板里面就可以找到。

啊，可以看到啊，这里有我们创建的这两个模板啊，这两个是我之前就是说啊测试的时候写的，我就把它删掉。这两个是我们刚加的啊。以后我们要使用的时候，只需要从更多模板里面找到它，然后去插入模板，我们的模板就可以了，就有了，就可以按照我们的模板去写，把我们的请求地址改一改，所有的要改的地方改一改就可以啊，这样我们在写API的时候就会比较方便。麻将把。呃，我们用到的一些。模板，还有这个数据资源模板，还有API接口模板得统一一下啊。啊，之后你创建这个文章就可以了，还可以选择你要保存的一个目录啊，接下来呢。我们要干什么呢？就是对我们的这个文档啊，进行一些目录的一个创建。清楚吧，好。首先我们创建一个。一个目录啊。

数据字典。哎，就是我们表的一个相关的一个目录，是顶层目录，没有上级。啊，接着创建一个。啊，就是我们各个API接口的一个目录了。啊，创建什么呢。用户认证啊。我们用户所有用户认证相关的API放到这个目录里面。接着添加一个。前台。啊。然后添加一个后台。这样的话，我们把所有用户认证相关的API。啊。就放到这里面啊，如果这个名字不好区分的话呢，我们去编辑一下，把后面给加上一个API啊。

就说用户认证API，然后前台的相关的API都放到这里啊。啊，接着是我们的后台的这个API，这样的话，我们就啊建立这么三个目录之后，返回来看一看。就是这个样子的，我们需要写API的时候呢，就去对应的目录里面去写就可以了，如果啊，还需要在分级，我们再去目录里面去建可以，比如我们后台有这个用户的管理啊，还有这个商品的管理啊，我们再去建他的这个二级的一个子目录。啊，如果有其他的一些说明文档，可以放到这个前面，直接去建这个顶层的一个文档啊就可以了啊。包括我们的这个状态码，我们就放到了最外层，是不是这样当啊请求接口出现错误的时候，可以直接去我们再去看我们的状态码的一个情况。这是我们写项目之前的一些准备工作，当把这些准备工作做完之后，就可以开始啊，去完成我们的项目。