阿里强推,微服务初步:RESTful API 设计指南

本文介绍了RESTful API的设计细节,包括使用HTTPs协议、域名管理、版本控制、资源路径设计、HTTP动词的应用、信息过滤、状态码、错误处理、返回结果格式以及Hypermedia API的概念,旨在提供一套合理、易用的API设计指南。
摘要由CSDN通过智能技术生成

网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。

因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。

今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。

RESTful API

一、协议
API与用户的通信协议,总是使用HTTPs协议。

二、域名
应该尽量将API部署在专用域名之下。


https://api.example.com
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。


https://example.org/api/
三、版本(Versioning)
应该将API的版本号放入URL。


https://api.example.com/v1/
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。

四、路径(Endpoint)
路径又称"终点"(end

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值