Restful API

所谓 Restful API, 简单的说就是利用已有的四个 HTTP 动作实现对资源的四种操作:

  • GET 获取
  • POST 创建
  • PUT 更新
  • DELETE 删除

如果你拥有一个独立的客户端, 发送这四种动作是不成问题的, 可是如果你是做 RIA 开发(Flex 或 Silverlight), 目前的浏览器宿主只能支持 GET 和 POST. 后两种动作怎么办?

  • 采用的方法是读取 POST 表单里的 hidden 域 _method
    GET请求
    后端:
    
    @ResponseBody
     @GetMapping("/user/{id}")
     public User selectUserById(@PathVariable("id") Integer id){
            return userService.getUserById(id);
     }
    前端:
    
    localhost:8083/user/1
    
    POST请求
    后端:
    
    @ResponseBody
    @PostMapping("/user")
    public User insert(User user){
        System.out.println("Get请求...");
        userService.insert(user);
        return user;
    }
    前端:
    
    <form action="http://localhost:8083/user" method="post">
    	<input type="text" name="id" value="1"/>
    	<input type="text" name="name" value="one"/>
    	<input type="submit" value="提交"/>
    </form>
    PUT请求
    后端:
    
    @ResponseBody
        @PutMapping("/user")
        public User update(User user){
            System.out.println("Put请求...");
            System.out.println(user);
            return userService.update(user);
        }
    前端:
    
    <form action="http://localhost:8083/user" method="post">
    	<input type="text" name="id" value="1"/>
    	<input type="text" name="name" value="one"/>
    	<input type="text" name="_method" value="PUT"/>
    	<input type="submit" value="提交"/>
    </form>
    DELETE请求
    后端:
    
    @DeleteMapping("/user/{id}")
        @ResponseBody
        public String delete(@PathVariable("id") Integer id){
            System.out.println("Delete请求...");
            userService.delete(id);
            return "从缓存中删除编号为"+id+"的对象,下一次将从数据库中查询该对象";
        }
    前端:
    
    <form action="http://localhost:8083/user/1" method="post">
    	<input type="text "name="_method" value="DELETE"/>
    	<input type="submit" value="提交"/>
    </form
    
    $.ajax({
      headers: {
        'X-HTTP-Method-Override': 'DELETE'
      },
      method: 'GET'
      // more parameters...
    });
### Restful API 的使用教程与原理介绍 #### 什么是 RESTful API? REST(Representational State Transfer)是一种软件架构风格,用于设计网络应用程序。它基于 HTTP 协议,利用标准的 HTTP 方法(如 GET、POST、PUT 和 DELETE),来执行 CRUD(Create, Read, Update, Delete)操作[^1]。 #### RESTful API 的核心原则 1. **无状态性**:每次请求都应独立完成,服务器不应保存任何客户端的状态信息。 2. **统一接口**:通过标准化资源标识符(URI)、HTTP 动词以及媒体类型定义交互方式。 3. **分层系统**:允许中间件的存在,例如缓存代理或负载均衡器。 4. **可缓存性**:响应数据可以被标记为可缓存或不可缓存,从而减少不必要的通信开销。 #### 构建 RESTful API 的基本步骤 以下是构建一个简单 RESTful API 所需的关键要素: 1. **选择框架** Python 中常用的 Web 框架之一是 Flask,配合 Flask-RESTful 可快速搭建 API 应用程序[^3]。 ```python from flask import Flask from flask_restful import Resource, Api app = Flask(__name__) api = Api(app) class HelloWorld(Resource): def get(self): return {'message': 'Hello, World!'} api.add_resource(HelloWorld, '/') if __name__ == '__main__': app.run(debug=True) ``` 2. **定义资源路由** 资源通常表示数据库中的实体,例如用户、订单等。每种资源都有对应的 URI 表示其位置,并通过不同的 HTTP 方法对其进行操作。 3. **实现字段校验** 对于传入的数据,可以通过库如 `marshmallow` 进行字段验证,确保输入的有效性和安全性[^1]。 #### 认证机制简介 为了保护 API 不被未授权访问,在实际项目中常采用 API 密钥认证的方式。具体流程如下: - 客户端向授权服务器申请唯一 API Key; - 授权成功后,该 Key 将存储至数据库供后续验证; - 后续调用时,客户端需携带此 Key 请求服务端进行身份确认[^4]。 尽管 RESTful API 提供了一套优雅的设计模式,但在某些情况下也可能存在局限性,例如复杂的业务逻辑难以完全映射到资源模型上等问题[^2]。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值