6.api接口开发

接口规范:Restful风格。具体参考之前的课件。
参考豆瓣api开发。下边是地址~~~
https://www.jianshu.com/p/6c6f90e3bc8c

Json格式数据,参考下边的文章。
https://www.jianshu.com/p/7e1459f064f5
重点理解对象和数组!!!
json格式数据

{
    "error_code": 0,
    "data": [
        {
            "id": "28241",
            "code": "4401",
            "parentid": "44",
            "name": "广州市",
            "level": "2"
        },
        {
            "id": "28421",
            "code": "4402",
            "parentid": "44",
            "name": "韶关市",
            "level": "2"
        },
        {
            "id": "28558",
            "code": "4403",
            "parentid": "44",
            "name": "深圳市",
            "level": "2"
        },
       ....
    ]
}

我们主要讲解怎么写接口,其实就是按照某种规范,写控制器。
软件架构说明 -- 单独的 api 模块, 单独文件进行配置, 只返回json格式的数据。

image.png

我们来创建一个api模块。 v1是版本的意思,是一个文件夹。


image.png

思考:此时如何访问?
如果我们还是按照原来的 模块/控制器/方法 来访问的话报错了。

image.png

因为多了个v1,所以访问的时候,应该是这样,模块/v1.控制器/方法!
注意这个 . 点
image.png

因为是接口开发,返回的数据应该是前端同学要的json格式的数据,所以我们还需要单独的写一下配置!
所以在api模块下建一个config文件夹,创建一个app.php。 可以复制配置文件app.php来修改。


image.png

这样的好处是,我们返回的数组,可以直接转换为json格式的数据!


image.png

这就是一个最基本使用,为了显示专业,我们一般都是使用postman来测试接口,而不是浏览器!群软件里边有,自行下载!

image.png

关于postman如何使用?请参考下边的文章。我会简单讲解基本使用。
https://www.jianshu.com/p/3baa9ae743a5

打开postman再次请求接口


image.png

添加一个 一维数组来测试


image.png

image.png

添加一个二维数组测试


image.png

image.png

注意此时,返回的data是一个数组,数组里边每条数据是一个对象 { } 。
所以我们在返回数据的时候,根据要求和格式,自行组装前端同学想要的数据格式!!!

接口中也有很多验证的规则,权限,密钥,安全性等等,以后项目中在实际讲解。

前后端分离开发,在我们写完接口,测试的时候需要写接口文档。方便查阅和维护。
有很多工具可以自动生成接口文档,但是必须要掌握如何写文档。其实很简单,类似excel表格。


image.png

上图就是一个完整的接口代码。
地址示例:
https://www.showdoc.cc/171695007958295?page_id=974559415325021

推荐大家使用showdoc,简单快速的写接口文档。可以保存,分享!
试着写一下文档吧!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容