优秀API的设计原则与实例实现RESTful(2)

简介: 优秀API的设计原则与实例实现RESTful(2)

--java_out表示在目标目录中生成Java代码。由于已将product.proto放到src/mian/java/proto目录下,所以--java_out=../java参数会将生成的Java类创建到java目录下,如图2-14所示。


image.png


打开ProtobufProtos会发现,这是一个非常复杂的类,其代码大概1500行。

4.使用Protobuf序列化

引入Protobuf-java包,可以先通过http://mvnrepository.com查询,然后点击复制,非常方便,如图2-15所示。


image.png


实际上,Protobuf的序列化及反序列化非常简单。Protobuf生成的类中已经实现了相应的方法,调用即可。示例代码如下。


package com.cloudnative.protobuf;
import com.google.protobuf.InvalidProtocolBufferException;
public class TestProtobuf {
    public static void main(String[] args){
        TestProtobuf testProtobuf =new TestProtobuf();
        byte[] buf=testProtobuf.toByte();
        try {
            ProductProtos.Product product = testProtobuf.toProduct(buf);
            System.out.println(product);
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }
    }
    //序列化
    private byte[] toByte(){
        ProductProtos.Product.Builder productBuilder=ProductProtos.Product.newBuilder();
        productBuilder.setId(11);
        productBuilder.setName("milk");
        productBuilder.setPrice("4.12");
        ProductProtos.Product product =productBuilder.build();
        byte[] buf = product.toByteArray();
        System.out.println(buf.length);
        return buf;
    }
    //反序列化
    private ProductProtos.Product toProduct(byte[] buf) throws InvalidProtocolBufferException {
        return ProductProtos.Product.parseFrom(buf);
}
}


服务间通信RESTful

RESTRoy Thomas Fielding2000年的博士论文中提出的。RESTRepresentational State Transfer的缩写,通常翻译为“表现层状态转化”。如果一个架构符合REST原则,就称它为RESTful架构。

API如何设计才能满足RESTful的要求呢?

1.协议

API基于HTTP协议


2.域名

API要有一个域名,例如http://api.xxx.com


3.版本

API要有版本信息。客户端数量较多或者提供给第三方使用时,很难控制客户端兼容性,一个比较好的做法就是当已发布服务变更时,通过版本来控制兼容性。当然,版本不能演进太快,最好的版本化就是无须版本例如http://api.xxx.com/v1/


4.路径


理解REST首先要理解什么是资源(Resource)。REST开发又被称作面向资源的开发。API资源来表示,URL不能出现动词资源是服务端可命名的一个抽象的概念,只要客户端容易理解,可以随意抽象。通常可以资源看成是一个实体例如用户、邮件、图片,用URI(统一资源定位符)指向它。经验告诉我们往往这里的资源和数据库表名是对应关系。一种观点认为DDD可以REST API很好契合,因为REST的资源可以很好地与DDD的实体映射起来定义资源的时候,推荐用复数,假设我们要获取用户的信息,大概是这样http://api.xxx.com/v1/users/


5.方法


一般允许的方法主要包括如下几种。

· GET:读取资源,一个或多个(常用)。

· POST:创建资源(常用)。

· PUT:修改资源,客户端提供修改后的完整资源(常用)。

· PATCH:对已知资源进行局部更新,客户端只需要提供改变的属性

· DELETE:删除、回收资源(常用)。

· HEAD:读取资源的元数据(不常用)。

· OPTIONS:读取对资源的访问权限(不常用)。

一般情况下GETPOSTPUTDELETE已经够,甚至有一种观点认为,只需要使用GETPOST即可,例子如下所示。

· GET/users/1获取用户ID1用户信息。

· GET/users/1/orders获取用户ID1用户拥有的所有订单。


6.参数


参数可以放到API路径中,也可以放到?”的后面


GET/users/1/orders
GET/orders?user_id=1


7.编码

虽然RESTful并没有限制资源的表达格式,HTML/XML/JSON/纯文本/图片/视频/音频等都可以,但是通常服务端和客户端通过JSON传递信息

8.状态码

HTTP Status Code传递Server的状态信息,常用的状态码如下

· 100Continue

· 200OKGET

· 201CreatedPOST/PUT/PATCH

· 202Accepted

· 204NO ContentDELETE

· 400Bad RequestPOST/PUT/PATCH

· 401Unauthorized

· 403Forbidden

· 404Not Found

· 405Method Not Allowed

· 406Not Acceptable

· 409Conflict

· 410Gone

· 412Precondition Failed

· 429Too many requests

· 500Internal Server Error

· 501Not Implemented

· 503Service Unavailable

完整信息可以参考w3官网。

要理解RESTful,还要考虑如下重要的约束条件。当然,这些条件也不是绝对的,需要结合业务场景来确定。

· 单一职责尽量保持接口职责单一,留给客户端足够的操作空间以满足不同的业务需求。对于接口粒度的大,需要考虑的因素包括:性能合并请求性能更高)、一致性灵活性及客户端的易用程度。

· 幂等性一次和多次请求某一个资源应该具有同样的作用,客户端能够重复发起请求不必担心造成作用。

· 无状态多次请求之间不应该存在状态耦合,无须关联过去、现在和将来的请求或者响应

· 客户端发起。一般通信方式都是由客户端发起的,服务端是被调用的。随着HTTP/2的到来,这一条可能会发生变化

· 原子性保证所有操作是一个不可分割的单元,要么全部成功,要么全部失败,需要结合业务要求加以确定。

· 易用需要提供详尽的文档参数说明、示例等,API定义的URL变量名要通俗易懂最好是英文,尽量减少自定义的缩写,让开发者容易调试和管理

· SLA需要提供响应时间、吞吐量可用性关键指标。

RESTful已经成为业界的主流,主要是因为RESTful通常采用HTTP+JSON的方式实现,继承了HTTPJSON的优点。相对于SOAPRPC等方式,RESTful更加轻量、简单,支持跨语言,并且容易调试。

通过Swagger实现RESTful

传统API设计通常先完成代码,然后另外补充一份说明文档,这种方式效率比较低文档和代码缺乏关联性。更高级一点的做法是使用JAVADOC把文档和注释关联起来,提升效率,但是由于JAVADOC需要不断生成,文档难免代码存在不一致。

在此背景下,Swagger诞生了。Swagger是一个简单、功能强大、非常流行API表达工具。基于Swagger生成API,可以得到交互式文档、自动生成代码的SDK,以及API的发现方式等。通过Swagger可以很容易地生成标准的API示例如图2-16所示。


image.png

相关文章
|
11天前
|
安全 Java API
RESTful API设计与实现:Java后台开发指南
【4月更文挑战第15天】本文介绍了如何使用Java开发RESTful API,重点是Spring Boot框架和Spring MVC。遵循无状态、统一接口、资源标识和JSON数据格式的设计原则,通过创建控制器处理HTTP请求,如示例中的用户管理操作。此外,文章还提及数据绑定、验证、异常处理和跨域支持。最后,提出了版本控制、安全性、文档测试以及限流和缓存的最佳实践,以确保API的稳定、安全和高效。
|
14天前
|
小程序 前端开发 API
小程序全栈开发中的RESTful API设计
【4月更文挑战第12天】本文探讨了小程序全栈开发中的RESTful API设计,旨在帮助开发者理解和掌握相关技术。RESTful API基于REST架构风格,利用HTTP协议进行数据交互,遵循URI、客户端-服务器架构、无状态通信、标准HTTP方法和资源表述等原则。在小程序开发中,通过资源建模、设计API接口、定义资源表述及实现接口,实现前后端高效分离,提升开发效率和代码质量。小程序前端利用微信API与后端交互,确保数据流通。掌握这些实践将优化小程序全栈开发。
|
23天前
|
前端开发 Java API
构建RESTful API:Java中的RESTful服务开发
【4月更文挑战第3天】本文介绍了在Java环境中构建RESTful API的重要性及方法。遵循REST原则,利用HTTP方法处理资源,实现CRUD操作。在Java中,常用框架如Spring MVC简化了RESTful服务开发,包括定义资源、设计表示层、实现CRUD、考虑安全性、文档和测试。通过Spring MVC示例展示了创建RESTful服务的步骤,强调了其在现代Web服务开发中的关键角色,有助于提升互操作性和用户体验。
构建RESTful API:Java中的RESTful服务开发
|
27天前
|
XML JSON 安全
谈谈你对RESTful API设计的理解和实践。
RESTful API是基于HTTP协议的接口设计,通过URI标识资源,利用GET、POST、PUT、DELETE等方法操作资源。设计注重无状态、一致性、分层、错误处理、版本控制、文档、安全和测试,确保易用、可扩展和安全。例如,`/users/{id}`用于用户管理,使用JSON或XML交换数据,提升系统互操作性和可维护性。
18 4
|
29天前
|
安全 API 开发者
构建高效可扩展的RESTful API服务
在数字化转型的浪潮中,构建一个高效、可扩展且易于维护的后端API服务是企业竞争力的关键。本文将深入探讨如何利用现代后端技术栈实现RESTful API服务的优化,包括代码结构设计、性能调优、安全性强化以及微服务架构的应用。我们将通过实践案例分析,揭示后端开发的最佳实践,帮助开发者提升系统的响应速度和处理能力,同时确保服务的高可用性和安全。
29 3
|
1月前
|
缓存 前端开发 API
构建高效可扩展的RESTful API:后端开发的最佳实践
【2月更文挑战第30天】 在现代Web应用和服务端架构中,RESTful API已成为连接前端与后端、实现服务间通信的重要接口。本文将探讨构建一个高效且可扩展的RESTful API的关键步骤和最佳实践,包括设计原则、性能优化、安全性考虑以及错误处理机制。通过这些实践,开发者可以确保API的健壮性、易用性和未来的可维护性。
|
1月前
|
API 开发者 UED
深入探讨RESTful API设计原则及最佳实践
在当今互联网时代,RESTful API已成为各种软件系统之间进行通信的重要方式。本文将从资源定义、URI设计、HTTP方法选择、状态码规范等方面深入探讨RESTful API设计的原则与最佳实践,帮助开发者更好地构建高效、健壮的API。
|
1月前
|
JSON API 数据库
解释如何在 Python 中实现 Web 服务(RESTful API)。
解释如何在 Python 中实现 Web 服务(RESTful API)。
26 0
|
1月前
|
缓存 安全 测试技术
构建高效的RESTful API:后端开发的实践指南
【2月更文挑战第17天】在数字化转型的浪潮中,RESTful API已成为连接不同软件组件、实现数据交互的核心桥梁。本文将深入探讨如何构建一个高效、可扩展且安全的RESTful API,涉及设计原则、开发流程以及性能优化等关键方面。我们将透过实际案例,展示如何在保证简洁性和灵活性的同时,满足日益增长的业务需求和技术挑战。
|
1月前
|
JSON Java API
Springboot项目中如何设计一个规范的统一的Restful API 响应框架?
Springboot项目中如何设计一个规范的统一的Restful API 响应框架?
23 1