资讯

历史

科技

环境与自然

成长

游戏

财经

文学与艺术

美食

健康

家居

文化

情感

汽车

三农

军事

旅行

运动

教育

生活

星座命理

REST API是什么及其核心概念

创作时间:

作者:

@小白创作中心

REST API是什么及其核心概念

引用

来源

https://www.explinks.com/blog/ua-rest-api-what-is-it-and-its-core-concepts/

本篇文章将深入探讨REST API的定义、核心约束和最佳实践，以及Apache APISIX如何助力RESTful API的实现和优化。通过阅读，您将对RESTful API有一个全面的了解。

REST API的定义和基本原理

REST，全称为Representational State Transfer，即表现层状态转移，是目前互联网上最流行的API架构风格之一。它通过HTTP协议实现客户端和服务端之间的通信和交互。

REST的核心约束条件

REST架构风格由六个指导性约束组成，包括客户端-服务器架构、无状态、可缓存性、分层系统、按需代码和统一接口。这些约束条件共同定义了RESTful API的行为和通信方式。

图片来源：Seobility

RESTful API的最佳实践

在设计RESTful API时，遵循最佳实践可以提高API的可用性、可维护性和扩展性。以下是一些关键的最佳实践。

路径名称避免动词

在RESTful API设计中，应使用HTTP方法来表达资源的操作行为，而不是在路径中使用动词。例如，使用

GET /orders

获取订单列表，而不是

GET /getOrders


curl -X GET http://httpbin.org/orders  
curl -X GET "http://httpbin.org/getOrders"

URI使用复数形式

资源命名应使用复数形式，以表示资源的集合，如

/orders

而不是

/order

。这有助于区分单个资源和资源集合。


curl -X GET "http://httpbin.org/orders"  
curl -X GET "http://httpbin.org/order"

善用HTTP状态码

正确使用HTTP状态码可以提供关于API响应的有用信息。例如，

200 OK

表示请求成功，

404 Not Found

表示资源未找到。


curl -X GET http://httpbin.org/orders  
curl -X GET http://httpbin.org/orders/nonexistent

版本管理

随着业务的发展，API可能需要更新和迭代。通过在API路径、查询参数或头部中包含版本号，可以管理不同版本的API。


curl http://httpbin.org/v1/orders  
curl http://httpbin.org/v2/orders

Apache APISIX助力RESTful API

Apache APISIX是一个动态、实时、高性能的API网关，它可以帮助我们在任何RESTful API服务上运行，并使用插件来添加新的服务和扩展其功能。

分层系统：支持业务逻辑和安全逻辑的分割

APISIX可以在业务服务器前面加一层认证逻辑，起到保护上游服务的作用，让你的业务逻辑和安全逻辑高效解耦。

Layered system：多负载均衡协议支持

APISIX作为API网关，可以设立在客户端和服务端之间，完成不同的负载需求。支持的负载均衡算法包括roundrobin、chash、ewma等。

统一接口：使历史API更加RESTful

对于已经存在很久的历史API，如果没有很好地遵循RESTful API准则，可以通过APISIX来封装新的API以满足不同的业务场景。

使用proxy-rewrite改写客户端请求

例如，历史版本API有

/getOrder

接口，我们可以通过

proxy-rewrite

插件来将API请求代理到历史API上：


curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '  
{  
    "methods": ["GET"],  
    "uri": "/orders",  
    "plugins": {  
        "proxy-rewrite": {  
            "uri": "/getOrder",  
            "scheme": "http",  
        }  
    },  
    "upstream": {  
        "type": "roundrobin",  
        "nodes": {  
            "127.0.0.1:80": 1  
        }  
    }  
}'

使用response-rewrite插件改写服务端响应

当我们的历史API存在响应状态码不规范时，可以通过

response-rewrite

代理response响应从而达到修改响应状态码的目的。


curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '  
{  
    "methods": ["GET"],  
    "uri": "/orders",  
    "plugins": {  
        "response-rewrite": {  
            "status_code": 201,  
            "body": "{"code":"ok","message":"new json body"}",  
            "vars":[  
                [ "status","==",200 ]  
            ]  
        }  
    },  
    "upstream": {  
        "type": "roundrobin",  
        "nodes": {  
            "127.0.0.1:80": 1  
        }  
    }  
}'