RESTful API 入门练习

于 2023-10-16 01:25:32 发布
阅读量104 收藏
点赞数
分类专栏： 基础技能 文章标签： restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_52431436/article/details/133850132
版权
  • perplexity如是说
    在这里插入图片描述
    在这里插入图片描述

文章目录

用reqres来练习

虽然说它主要是给前端做练习的hh，不过AI时代总是要用别人的api哈哈，练一练也好

practice1

import requests  # 导入requests模块，用于进行HTTP请求

"""
此代码演示如何使用reqres.in API进行各种RESTful操作。
"""


class AdvancedReqResAPI:

    # 定义API的基础URL，这样我们可以在整个类中重复使用它
    BASE_URL = "https://reqres.in/api"

    def __init__(self):
        """构造函数，当我们创建类的实例时会自动调用"""
        # 初始化一个Session对象，这个Session可以在多个请求之间保持状态（如登录状态、cookies等）
        # 这与浏览器的工作方式类似，浏览器会在多个请求中保存你的登录状态
        self.session = requests.Session()

    def login(self, email, password):
        """使用邮箱和密码进行登录，并从API响应中获取token"""
        # 定义登录的完整URL
        url = f"{self.BASE_URL}/login"
        # 定义登录请求所需的数据
        payload = {
            "email": email,
            "password": password
        }
        # 使用session发送POST请求进行登录
        response = self.session.post(url, json=payload)

        # 检查响应状态码和响应内容中是否包含token
        if response.status_code == 200 and "token" in response.json():
            # 从响应中提取token
            token = response.json()["token"]
            # 将token设置为session的headers中，这样后续的请求都会自动带上这个token进行认证
            self.session.headers.update({"Authorization": f"Bearer {token}"})
            return token
        # 如果登录失败，则返回None
        return None

    def all_users(self):
        """获取所有用户信息的生成器"""
        page = 1
        while True:
            users = self.fetch_users(page)
            if not users:
                break
            for user in users:
                # yield关键字用于定义生成器函数，每次调用next()时会返回一个值
                yield user
            page += 1

    def fetch_users(self, page=1):
        """根据指定的页面号获取用户列表"""
        url = f"{self.BASE_URL}/users?page={page}"
        try:
            # 使用session发送GET请求获取用户信息
            response = self.session.get(url)
            if response.status_code == 200:
                # 如果请求成功，返回用户数据
                return response.json()['data']
            return []
        except requests.RequestException as e:
            # 如果发生任何请求错误，打印错误并返回空列表
            print(f"Error fetching users: {e}")
            return []

    def create_users(self, name, job):
        """创建新用户"""
        url = f"{self.BASE_URL}/users"
        payload = {
            "name": name,
            "job": job
        }
        try:
            response = self.session.post(url, json=payload)
            if response.status_code == 201:
                return response.json()
            return None
        except requests.RequestException as e:
            print(f"Error creating user: {e}")
            return None

    def update_users(self, user_id, name, job):
        """更新特定ID的用户信息"""
        url = f"{self.BASE_URL}/users/{user_id}"
        payload = {
            "name": name,
            "job": job
        }
        try:
            response = self.session.put(url, json=payload)
            if response.status_code == 200:
                return response.json()
            return None
        except requests.RequestException as e:
            print(f"Error updating user with ID {user_id}: {e}")
            return None

    def delete_users(self, user_id):
        """删除特定ID的用户"""
        url = f"{self.BASE_URL}/users/{user_id}"
        try:
            response = self.session.delete(url)
            return response.status_code == 204
        except requests.RequestException as e:
            print(f"Error deleting user with ID {user_id}: {e}")
            return False




# 使用示例
import json
from pprint import pprint

api = AdvancedReqResAPI()
token = api.login("eve.holt@reqres.in", "cityslicka")
if token:
    print("登陆成功！")
    for user in api.all_users():
        pprint(user)
else:
    print("登陆失败。")

# C - Create a new user
new_user = api.create_users("Tom", "Developer")
print("Created user:")
pprint(new_user)

# R - Read users
users = api.fetch_users()
print("User List:")
pprint(users)

# R - Read a specific user
user = api.fetch_users(2)
print("Fetched user with ID 2:")
pprint(user)

# U - Update a user
updated_user = api.update_users(2, "Tom Updated", "Senior Developer")
print("Updated user:")
pprint(updated_user)

# D - Delete a user
deleted = api.delete_users(2)
if deleted:
    print("User deleted successfully.")
else:
    print("Failed to delete user.")


登陆成功！
{'avatar': 'https://reqres.in/img/faces/1-image.jpg',
 'email': 'george.bluth@reqres.in',
 'first_name': 'George',
 'id': 1,
 'last_name': 'Bluth'}
{'avatar': 'https://reqres.in/img/faces/2-image.jpg',
 'email': 'janet.weaver@reqres.in',
 'first_name': 'Janet',
 'id': 2,
 'last_name': 'Weaver'}
{'avatar': 'https://reqres.in/img/faces/3-image.jpg',
 'email': 'emma.wong@reqres.in',
 'first_name': 'Emma',
 'id': 3,
 'last_name': 'Wong'}
{'avatar': 'https://reqres.in/img/faces/4-image.jpg',
 'email': 'eve.holt@reqres.in',
 'first_name': 'Eve',
 'id': 4,
 'last_name': 'Holt'}
{'avatar': 'https://reqres.in/img/faces/5-image.jpg',
 'email': 'charles.morris@reqres.in',
 'first_name': 'Charles',
 'id': 5,
 'last_name': 'Morris'}
{'avatar': 'https://reqres.in/img/faces/6-image.jpg',
 'email': 'tracey.ramos@reqres.in',
 'first_name': 'Tracey',
 'id': 6,
 'last_name': 'Ramos'}
{'avatar': 'https://reqres.in/img/faces/7-image.jpg',
 'email': 'michael.lawson@reqres.in',
 'first_name': 'Michael',
 'id': 7,
 'last_name': 'Lawson'}
{'avatar': 'https://reqres.in/img/faces/8-image.jpg',
 'email': 'lindsay.ferguson@reqres.in',
 'first_name': 'Lindsay',
 'id': 8,
 'last_name': 'Ferguson'}
{'avatar': 'https://reqres.in/img/faces/9-image.jpg',
 'email': 'tobias.funke@reqres.in',
 'first_name': 'Tobias',
 'id': 9,
 'last_name': 'Funke'}
{'avatar': 'https://reqres.in/img/faces/10-image.jpg',
 'email': 'byron.fields@reqres.in',
 'first_name': 'Byron',
 'id': 10,
 'last_name': 'Fields'}
{'avatar': 'https://reqres.in/img/faces/11-image.jpg',
 'email': 'george.edwards@reqres.in',
 'first_name': 'George',
 'id': 11,
 'last_name': 'Edwards'}
{'avatar': 'https://reqres.in/img/faces/12-image.jpg',
 'email': 'rachel.howell@reqres.in',
 'first_name': 'Rachel',
 'id': 12,
 'last_name': 'Howell'}
Created user:
{'createdAt': '2023-10-15T17:04:35.496Z',
 'id': '700',
 'job': 'Developer',
 'name': 'Tom'}
User List:
[{'avatar': 'https://reqres.in/img/faces/1-image.jpg',
  'email': 'george.bluth@reqres.in',
  'first_name': 'George',
  'id': 1,
  'last_name': 'Bluth'},
 {'avatar': 'https://reqres.in/img/faces/2-image.jpg',
  'email': 'janet.weaver@reqres.in',
  'first_name': 'Janet',
  'id': 2,
  'last_name': 'Weaver'},
 {'avatar': 'https://reqres.in/img/faces/3-image.jpg',
  'email': 'emma.wong@reqres.in',
  'first_name': 'Emma',
  'id': 3,
  'last_name': 'Wong'},
 {'avatar': 'https://reqres.in/img/faces/4-image.jpg',
  'email': 'eve.holt@reqres.in',
  'first_name': 'Eve',
  'id': 4,
  'last_name': 'Holt'},
 {'avatar': 'https://reqres.in/img/faces/5-image.jpg',
  'email': 'charles.morris@reqres.in',
  'first_name': 'Charles',
  'id': 5,
  'last_name': 'Morris'},
 {'avatar': 'https://reqres.in/img/faces/6-image.jpg',
  'email': 'tracey.ramos@reqres.in',
  'first_name': 'Tracey',
  'id': 6,
  'last_name': 'Ramos'}]
Fetched user with ID 2:
[{'avatar': 'https://reqres.in/img/faces/7-image.jpg',
  'email': 'michael.lawson@reqres.in',
  'first_name': 'Michael',
  'id': 7,
  'last_name': 'Lawson'},
 {'avatar': 'https://reqres.in/img/faces/8-image.jpg',
  'email': 'lindsay.ferguson@reqres.in',
  'first_name': 'Lindsay',
  'id': 8,
  'last_name': 'Ferguson'},
 {'avatar': 'https://reqres.in/img/faces/9-image.jpg',
  'email': 'tobias.funke@reqres.in',
  'first_name': 'Tobias',
  'id': 9,
  'last_name': 'Funke'},
 {'avatar': 'https://reqres.in/img/faces/10-image.jpg',
  'email': 'byron.fields@reqres.in',
  'first_name': 'Byron',
  'id': 10,
  'last_name': 'Fields'},
 {'avatar': 'https://reqres.in/img/faces/11-image.jpg',
  'email': 'george.edwards@reqres.in',
  'last_name': 'Edwards'},
 {'avatar': 'https://reqres.in/img/faces/12-image.jpg',
  'email': 'rachel.howell@reqres.in',
  'first_name': 'Rachel',
  'id': 12,
  'last_name': 'Howell'}]
Updated user:
{'job': 'Senior Developer',
 'name': 'Tom Updated',
 'updatedAt': '2023-10-15T17:04:36.199Z'}

practice2

import requests
import json

class CampusManagementSystem:
    # 基础URL，用于API请求的基础部分
    BASE_URL = "https://reqres.in/api/"

    @staticmethod  # 使用staticmethod装饰器定义静态方法，这样方法可以不通过类实例直接调用
    def get_students_list(page=1):
        """
        从服务器获取学生列表。

        :param page: 要获取的学生列表的页码，默认为1。
        :return: 学生列表，如果请求失败则返回空列表。
        """
        # 构造完整的API请求URL
        endpoint = f"users?page={page}"
        url = CampusManagementSystem.BASE_URL + endpoint

        # 发起GET请求
        response = requests.get(url)

        # 检查响应状态码，200表示请求成功
        if response.status_code == 200:
            # 解析响应内容为JSON格式并获取"data"键的值，如果不存在则返回空列表
            students = response.json().get("data", [])
            return students
        else:
            print("获取学生数据失败。")
            return []

    @staticmethod
    def add_student(name, course):
        """
        向服务器添加新学生。

        :param name: 学生姓名。
        :param course: 学生所学课程。
        :return: 如果添加成功则返回学生数据，否则返回None。
        """
        endpoint = "users" # endpoint是API的路径部分
        url = CampusManagementSystem.BASE_URL + endpoint
        
        # 定义请求头，指明内容类型为JSON
        headers = {
            "Content-Type": "application/json"
        }

        # 构建请求的数据体
        data = {
            "name": name,
            "course": course
        }

        # 使用json.dumps()方法将Python字典转换为JSON字符串
        response = requests.post(url, headers=headers, data=json.dumps(data))

        # 检查响应状态码，201表示创建成功
        if response.status_code == 201:
            student = response.json()
            return student
        else:
            print("添加学生失败。")
            return None


if __name__ == "__main__":
    # 获取学生列表并打印
    students = CampusManagementSystem.get_students_list()
    for student in students:
        print(f"ID: {student['id']}, 姓名: {student['first_name']} {student['last_name']}")

    # 添加新学生并打印其信息
    new_student = CampusManagementSystem.add_student(name="John Doe", course="Computer Science")
    if new_student:
        print(f"已添加新学生，ID: {new_student['id']}, 姓名: {new_student['name']}, 课程: {new_student['course']}")

让DALLE画图解释api！！！

  • Dalle3真的太令人震撼了…

在这里插入图片描述
在这里插入图片描述

  • 解释session
    在这里插入图片描述
临风而眠
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【RESTful API】RESTful接口设计练习
weixin_52553215的博客
11-28 119
常见的有。
RESTful API介绍
静幽水
05-26 2925
使用HTTP缓存机制不仅可以减轻服务器的压力，同时也可以提高客户端的访问速度，改善API的性能。ETag机制：ETag是一个资源的唯一标识，可以在服务器端记录资源的ETag值，并在客户端请求时与客户端发送相应的ETag值进行比较，如果一致则表示资源未被修改，可以直接使用缓存。ETag机制：ETag是一个资源的唯一标识，可以在服务器端记录资源的ETag值，并在客户端请求时与客户端发送相应的ETag值进行比较，如果一致则表示资源未被修改，可以直接使用缓存。
详解 restful API
weixin_53156345的博客
05-15 2692
​ 服务器不能保存客户端的信息，每一次从客户端发送的请求中，要包含所有必须的状态信息，会话信息由客户端保存，服务器端根据这些状态信息来处理请求，当客户端可以切换到一个新状态的时候发送请求信息，当一个或者多个请求被发送之后，客户端就处于一个状态变迁过程中。从请求方式上无法知道API是干嘛的，素有在URL上都会有操作的动词来表示API进行的动作，例如：query，add，update，delete等等。安全性是指：方法不会修改资源状态，朗读的为安全的，写的操作为非安全的。
RESTful 概念
越自律越自由
04-16 652
概念 RESTful通常采用Http+JSON实现。Representational State Transfer 全称翻译为表现层状态转化。REST 是属于 WEB 自身的一种架构风格，是在 HTTP 1.1 规范下实现的。REST最大的几个特点为：资源、统一接口、URI和无状态。 Resource：资源。就是网络上的一个实体。 Representational：表现形式，比如用JSON，...
什么是RESTful API?
Evan's Blog ٩(๑❛ᴗ❛๑)۶
12-25 9万+
        提到RESTful API 大家势必或多或少听说过。但是什么是RESTful API ？如何理解RESTful API 呢？请大家耐心读完这篇文章，相信您读完后一定会有一个更好的理解。我个人认为，要弄清楚什么是RESTful API,首先要弄清楚什么是REST。REST 全称：REpresentational State Transfer，英文翻译过来就是“表现层状态转化”。如果...
API入门课程：API入门课程
01-30
在本“API入门课程”中，我们将探讨API（应用程序编程接口）的基础知识，以及如何开始在你的项目中使用它们。API是软件系统之间交互的一种方式，允许不同的应用程序共享数据和服务，从而实现更高效的开发和协作。 ...
ruby 入门练习上手项目
最新发布
02-18
10. **RESTful API设计**：了解如何在Rails中构建符合REST原则的API，包括HTTP动词（GET, POST, PUT, DELETE）和资源的表示。 11. **测试驱动开发(TDD)**：Rails提倡TDD，你将学习如何使用RSpec或MiniTest编写测试...
API-Ejercicio-1.1-入门
02-22
在完成这个入门练习后，开发者将对API有一个基本的理解，并能构建简单的API调用来获取和展示数据。这将为更高级的API使用，如处理分页、过滤和排序等奠定基础。同时，这个练习也可能涉及JSON格式数据的解析和使用，...
WebApi入门到精通视频课程.txt打包整理.zip
03-05
"WebApi入门到精通视频课程.txt打包整理.zip"，这表明这个压缩文件是一个完整的WebApi学习资料集合，其中包含的视频课程可能覆盖了从初级到高级的所有主题，而.txt文件可能是配套的文字材料，如课程笔记、代码示例或...
webdriver编程入门
01-14
WebDriver编程入门详解 WebDriver是一种用于自动化Web浏览器的工具，它允许程序员编写脚本来模拟用户与网页的交互。在本文中，我们将深入探讨WebDriver的工作原理，并通过实例帮助新手理解如何开始使用WebDriver...
REST与RESTFul API最佳实践
05-30 3万+
我经常会面试一些做PHP的开发者，让我很奇怪的是，10个人总有8个多不知道什么是REST服务，甚至是没有听说过。但RESTFul API已经是现在互联网里对外开放接口的主流模式，可参考： 豆瓣API https://developers.douban.com/wiki/?title=api_v2 GitHub https://developer.github.com/v3/ 数一
RESTful从入门到熟练，看完这篇就够了
langfeiyes的博客
02-10 5781
RESTful从入门到熟练，看完这篇就够了
REST API 的最佳入门教程
weixin_30580943的博客
12-15 6994
如果你看到这里，你以前可能听说过API 和REST,然后你就会想:“这些都是什么东西？”。也许你已经了解过一些这方面的知识，但却不知道从何入手。在这个教程中，我将会诠释REST的基础以及如何给应用创建一个API（包括认证授权） 什么是API? API是Application Programming Interface（应用程序界面）的缩写，它是拿来描述一个类库的特征或是如何去运用它。你个...
RESTful API 简介（学习笔记）
畅春园
02-09 1451
RESTful接口的命名规范与语义格式 RESTful是一种网络应用程序的设计风格和开发方式，可以使用xml方式来定义或者json格式来定义。RESTful适用于移动互联网厂商作为业务接口的场景，实现调用移动网络资源的功能。 动作类型：新增、修改、删除所调用的资源。 RESTful的三个要点： 1. 基于http协议URL对外暴露； URL被视为资源，中括号的内容为可选项。 2. 使用XML或者JSON格式定义数据，不可以包含任何与展现有关的内容。比如，下图中返回了浏览器才能解析的内
java处理通过RESTful API 获取索引和属性信息
小栋哟
09-23 2578
上个博客写了通过RESTful API 获取es索引和属性信息的方式，点我就能看 这次记录下拿到数据后的一个处理，不废话直接上代码 ~ import com.alibaba.fastjson.JSONArray; import com.alibaba.fastjson.JSONObject; import org.apache.commons.lang3.StringUtils; import org.springframework.util.Assert; import java.io.Buffer
restapi是什么意思_什么是REST 、RESTful 、RESTful API？
weixin_29156401的博客
12-24 1059
介绍自从Roy Fielding博士在2000年他的博士论文中提出Rest(Representational State Transfer)风格的软件架构模式后，REST就基本上迅速取代了复杂而笨重的SOAP，成为Web API的标准了。什么是Web API呢？如果我们想要获取某个电商网站的某个商品，输入http://localhost:8080/demo/products/123，就可以看到id...
通俗易懂RESTful，如何设计RESTful风格API
zhangmiaoping23的专栏
05-21 184
REST -- REpresentational State Transfer 直译：表现层状态转移。这个中文直译经常出现在很多文章中。尼玛，谁听得懂“表现层状态转移”，这是人话吗？ 那就逐个单词来理解REST名称 REST -- REpresentational State Transfer 首先，之所以晦涩是因为前面主语被去掉了，全称是 Resource Representational State Transfer：通俗来讲就是：资源在网络中以某种表现形式进行状态转移。分解开来： Resource：
Rest API 的那些事儿
Wangguizer的博客
01-07 1万+
一、前言　　在软件行业快速发展的今天，传统的软件授权已经不能足以满足一个IT类的公司的发展。虽然在大部分公司里，它还是现金池的直接源头。但是在可遇见的未来，受摩尔根理论的失效、物联网的发展等影响，应用的架构会越来越趋于简单化，架构越来越倾向于分布式水平扩展，对外的服务提供也会越来越SaaS化。在这种大背景下，很多公司都开始提供所谓的开放平台。　　查阅各个大公司的开放平台，我们不难发现，都是Rest
RESTful API接口设计标准及规范；
热门推荐
时光偏执的博客
01-12 28万+
RESTful发展背景及简介 网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备…）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"APIFirst"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。 REST（Representational Stat...
连接系统的秘钥：API入门指南
"《API入门指南》由Brian Cooksey撰写，编辑工作由Bryan Landers和Danny Schreiber共同完成，封面设计则出自Stephanie Briones的手笔。该书首次发布日期为2014年4月23日，由Zapier, Inc.出品。这本书旨在帮助读者...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值