从头完成一个restful API 服务(续)

简介: 从头完成一个restful API 服务(续)

01.完善设计


在上次的设计当中,我定义了三张表,AdminUser,用来作为调用API鉴权用户,User,用来作为存储普通用户使用,Picture,用来作为存储用户上传的图片。但是当时只是实现了AdminUser的相关功能,而User和Picture还没有真正的关联起来,这次就把它们完善起来


02.测试server


为了方便测试,我这里写了一个简单的测试web server,用来在网页上向API服务器发请求。代码很简单,还是用flask来启动server,返回一个页面。

@app.route('/jsupload', methods=['POST', 'GET'])
def jsupload():
    return render_template('js_upload.html')

而返回的这个页面也很简单,包含一个form,用来提交数据的。

<form id= "uploadForm">
    <p >指定用户名: <input type="text" name="filename" value= "" id="UID"/></p>
    <p >上传文件: <input type="file" name="file" id="PID"/></p>
    <input type="button" value="上传" onclick="upload()" />
</form>

服务起来之后大概是这样的


image.png

不要嫌弃它丑,功能够了就行了。


这样一个简单的测试server就好了。


03.前端代码


前端代码使用Ajax来提交数据和回显数据


image.png

代码都是比较基础的,定位元素,调用函数,说下这里的url,那个就是我在本地启动的API server的地址喽。同时这里还在监听服务器的返回,获取到返回的p_url,来显示图片。


04. 后端代码


首先判断下前端传的是否是图片文件,如果不是直接返回错误

if 'PID' not in request.files:
    return jsonify({'code': -1, 'filename': '', 'msg': 'please select one picture to upload'})

如果判断通过,就获取图片和用户名称

user = request.form.get('UID')
f = request.files['PID']

然后在本地创建目录用于保存图片,并且着手处理User和Picture的关系


image.png

如果不存在目录则创建,并且保存图片。如果用户存在于数据库中,那么picture_count加1,同时更新Picture表,关联picture_id为user_id。


如果用户不存在,那么先插入用户,提交,然后再更新Picture表


image.png

最后API返回p_url用于前端web展示

return jsonify({"p_url": 'http://127.0.0.1:9980/static/%s/' % user + new_filename})

05. 最终效果


最后的效果如下


image.png


同时在项目的static目录下,会产生每个用户的图片,因为图片的命名都使用了time.time(),也就不存在重名覆盖的问题啦

image.png

06. 任重道远


这次的完善就到这里了,不过程序还是有很多问题的,比如我现在就知道如果在web端不填写名字或者不选择图片,都会产生一些问题;同时还可以增加一些接口,比如获取用户所有图片等待,这些都留到后面再说吧


还有个严峻的问题,就是每次本地调测好之后,都要手动同步代码到远程服务器,非常之麻烦,虽然目前项目很小,但是CI还是很有必要的,后面就来聊聊怎么结合GitHub做持续集成吧


获取源码看这里:

https://github.com/zhouwei713/mini_api

相关文章
|
16天前
|
JSON 缓存 JavaScript
深入浅出:使用Node.js构建RESTful API
在这个数字时代,API已成为软件开发的基石之一。本文旨在引导初学者通过Node.js和Express框架快速搭建一个功能完备的RESTful API。我们将从零开始,逐步深入,不仅涉及代码编写,还包括设计原则、最佳实践及调试技巧。无论你是初探后端开发,还是希望扩展你的技术栈,这篇文章都将是你的理想指南。
|
9天前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
26 12
|
13天前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
19天前
|
存储 API 数据库
使用Python和Flask构建简单的RESTful API
使用Python和Flask构建简单的RESTful API
|
19天前
|
JSON 关系型数据库 测试技术
使用Python和Flask构建RESTful API服务
使用Python和Flask构建RESTful API服务
|
27天前
|
SQL 缓存 测试技术
构建高性能RESTful API:最佳实践与避坑指南###
—— 本文深入探讨了构建高性能RESTful API的关键技术要点,从设计原则、状态码使用、版本控制到安全性考虑,旨在为开发者提供一套全面的最佳实践框架。通过避免常见的设计陷阱,本文将指导你如何优化API性能,提升用户体验,确保系统的稳定性和可扩展性。 ###
57 12
|
24天前
|
JSON JavaScript API
深入浅出Node.js:从零开始构建RESTful API
【10月更文挑战第39天】 在数字化时代的浪潮中,API(应用程序编程接口)已成为连接不同软件应用的桥梁。本文将带领读者从零基础出发,逐步深入Node.js的世界,最终实现一个功能完备的RESTful API。通过实践,我们将探索如何利用Node.js的异步特性和强大的生态系统来构建高效、可扩展的服务。准备好迎接代码和概念的碰撞,一起解锁后端开发的新篇章。
|
27天前
|
存储 API 开发者
深入理解RESTful API设计原则
本文探讨了RESTful API的设计原则,强调了其在现代Web服务中的重要性。通过分析状态表示转移(REST)的概念、核心约束以及最佳实践,本文旨在为开发者提供构建高效、可扩展和易于维护的API的指导。文章还讨论了常见的设计陷阱和如何避免它们,以确保API设计的健壮性和灵活性。
|
14天前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
14天前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
24 0