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,简单快速的写接口文档。可以保存,分享!
试着写一下文档吧!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容