RestFul API

它是什么

是一种基于http协议的网络应用程序接口设计风格,设计的目的是让计算机之间的交互更加简介,快速,可靠。

通常使用json 和xml 格式来传输数据

核心思想是将资源作为中心,通过http协议的get,post,put,delete 等方法来对资源进行操作

为什么使用

1,可读性好:URL结构清晰明了 易于使用

2,扩展性好:Restful API 采用标准的http协议,支持各种语言和开发环境,

3,可靠率高:Restful API 采用标准的http协议,具有良好的稳定性和可靠性

4,基本原则:

  使用HTTP动词 来描述操作: get 用户获取资源,post 用户创建资源,put 用于更新资源,delete 用户删除资源

  使用url 来描述资源,url 清晰明了,易于理解和使用 

  使用http 状态码来表述请求的结果,列如200 成功,404 资源不存在 500 服务器错误

怎么使用

加入我们设计一个Restful API来管理图书信息,我们可以使用以下URL来访问不同的资源:

  1. 获取所有图书信息:GET /books

  2. 获取指定图书信息:GET /books/{id}

  3. 创建新的图书信息:POST /books

  4. 更新指定图书信息:PUT /books/{id}

  5. 删除指定图书信息:DELETE /books/{id}

使用json格式创建一本新的图书:

POST /books

{
    "title": "Java从入门到精通",
    "author": "张三",
    "price": 99.9
}

如果创建成功,服务器会返回以下JSON格式的数据:

{
    "id": 1,
    "title": "Java从入门到精通",
    "author": "张三",
    "price": 99.9
}

以上就是一个简单的Restful API设计和使用的例子

 
posted @ 2023-05-29 15:57  Verite  阅读(12)  评论(0编辑  收藏  举报