5 天开发接口系统技术小结

Wesley13
• 阅读 558

在确定了接口系统的详细规划和整体功能以后,花费时间更多的其实是对技术细节的打磨。本主题借鉴我开发个人网站 魚立说 的经验,整理了在开发接口系统过程可能会遇到的各种技术要点。

本文来源:魚立说。本文链接:https://www.yulisay.com/d/cdmqv.html,支持微信浏览器打开。

更多精彩文章,请移步 魚立说个人网站 翻看。欢迎欣赏,吐槽不足之处。


涉及到的代码已经整理到 https://github.com/yulis-say/web-full-stack 中的 api-skills 目录,若觉得有用,请分享并 star 。

接口开发小结

下面对接口系统的开发技术要点依次进行概括,包括必要的说明和资源引导。

Laravel & Dingo API 使用技巧

搭建接口系统,为了省时省力,本站使用了 PHP 语言写的 Laravel & Dingo API 框架,接下来就相关使用经验进行了整理。

  • 管理 Laravel 项目的有用命令:

      生成一个随机字符串:[php](https://www.oschina.net/p/php "php") artisan key:generate
      启动一个开发服务器,之后通过 http://localhost:8000 地址访问:[php](https://www.oschina.net/p/php "php") artisan serve
      优化配置加载:[php](https://www.oschina.net/p/php "php") artisan config:cache
      优化路由加载:[php](https://www.oschina.net/p/php "php") artisan route:cache
      优化视图加载:[php](https://www.oschina.net/p/php "php") artisan view:cache
      启用维护模式:[php](https://www.oschina.net/p/php "php") artisan down
      禁用维护模式:[php](https://www.oschina.net/p/php "php") artisan up
    
  • 一些有用的 Laravel 扩展包:

      Laravel-Debugbar:便捷查看应用所有信息,以方便调试。
      Laravel-Permission:实现 RBAC 权限管理功能。
      Laravel-activitylog:自动记录Model的修改,记录用户行为扩展包。
      Laravel-CORS:解决前后端分离应用跨域请求利器。
      Laravel Excel:集成 Excel 表格,实现 Excel/CSV 等格式文件的导入导出。
      Laravel-Pay:支付宝和微信支付 SDK。
    
  • JWT(JSON Web Token)规范为基于 API 的用户认证提供了最佳解决方案,允许我们在用户和服务器之间传递安全可靠的信息。一个 JWT 实际上就是一个字符串,它由三部分组成:头部、载荷与签名。

  • 使用 QQ 邮箱发送邮件,需要开放 QQ 邮箱的 SMTP 功能。在 QQ 邮箱中做开启 POP3 和 SMTP 服务,如图:

5 天开发接口系统技术小结

API 与 JavaScript 实现交互

整个网站框架的底层其实就是:前端页面 + 后端支持。前端页面由 HTML/JavaScript/CSS 等技术实现。后端支持由 API 实现,并与数据库、文件系统等实现交互。因此,API 与 JavaScript 的交互,成为将前后端衔接起来的桥梁。

  • 如果通过 fetch() 请求 API 数据,我们可以对 fetch() 进行封装,从而方便后续的调用操作。比如这样进行封装:

      function myfetch(url, options = {}) {
          !options.method ? (options.method = 'GET') : null;
    
          options.mode = 'cors';
          options.headers = {
            'Content-Type': 'application/x-www-form-urlencoded'
          };
    
          return fetch(url, options).then(response => {
            return response.json();
          });
      }
    

5 天开发接口系统技术小结

  • 通过 HTTP 向 API 发送需要认证通过的请求时,需要将 token 信息包含到 URL 中,或者设置 Authorization 授权头:

      Authorization: Bearer+空格+token
    
  • JavaScript 读取前端 Laravel 设置的 Cookie 始终为空?因为安全的原因考虑,Laravel 框架默认会对 Cookie 进行加密存储。如果想要 Laravel 跟 JavaScript 实现 Cookie 的交互,也就是让 JavaScript 直接读取到明文,那么需要做如下配置:

      将 Cookie 名添加到 App\Http\Middleware\EncryptCookies 的排除名单中:
      protected $except = [
          'cookie_name',
      ];
    
      设置 Cookie 时,去除 HttpOnly 属性:
      \Cookie::queue('cookie_name', 'test', $minutes = 360, $path = null, $domain = null,
          $secure = false, $httpOnly = false);
    
  • 使用 Laravel Mix 编译资源,对 CSS 和 JavaScript 实现 Webpack 压缩打包。在运行 Laravel Mix 之前,需要具备 Node.js 和 NPM 运行环境。例如执行命令npm run prod,对 app.js 和 app.scss 文件进行编译:

      mix.js('resources/assets/js/app.js', 'public/js')
          .sass('resources/assets/sass/app.scss', 'public/css');
    

更多有用的网站

参考链接

Laravel Documentation

Dingo API 2.0.0 中文文档

tymondesigns/jwt-auth Wiki

使用 Fetch - Web API 接口参考 | MDN

编译资源(Laravel Mix) | 前端开发

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Stella981 Stella981
3年前
Android So动态加载 优雅实现与原理分析
背景:漫品Android客户端集成适配转换功能(基于目标识别(So库35M)和人脸识别库(5M)),导致apk体积50M左右,为优化客户端体验,决定实现So文件动态加载.!(https://oscimg.oschina.net/oscnet/00d1ff90e4b34869664fef59e3ec3fdd20b.png)点击上方“蓝字”关注我
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
可莉 可莉
3年前
10 天开发前台系统技术系列
在确定了前台系统的详细规划和整体功能以后,花费时间更多的其实是对技术细节的打磨。本篇文章是一个对前台开发技术进行概要整理,也会对其他的分主题进行一些引导。本文来源:魚立说。本文链接:https://www.yulisay.com/d/frontskill.html(https://www.oschina.net/action/GoToLink?url
Wesley13 Wesley13
3年前
7 天开发后台系统技术小结
在确定了后台系统的详细规划和整体功能以后,花费时间更多的其实是对技术细节的打磨。本主题借鉴我开发个人网站魚立说(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fwww.yulisay.com)的经验,整理了在开发后台系统过程可能会遇到的各种技术要点。本文来源:魚立说。本文链接:
Python进阶者 Python进阶者
10个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这