RESETful API接口设计规范 (reset翻译成中文怎么读出来)
本文目录导航：
RESETful API接口设计规范
开发环节中，咱们常需提供API接口给客户端或第三方经常使用，如何构建易于了解的API至关关键。
若在设计API时遵照规范，开发环节中的沟通老本和效率将大大优化。
本文将讨论RESTful API的设计规范。
以下为贯通全文的几个关键术语：资源（单个对象的实例，如生物）、汇合（同类型对象的汇合，如生物们）、HTTP（网络通讯协定）、生产者（可动员HTTP恳求的客户端运行程序）、第三方开发者（非名目组成员但宿愿经常使用数据的开发者）、服务（可经过网络访问的HTTP服务/运行）、节点（主机上的API URL，可代表资源或整个汇合）、幂等性（无反作用，可屡次执行）、URL段（URL中由斜杠分隔的信息段）。
数据形象与设计：需确定数据库设计及提供的web服务配置，以启动API设计。
API应尽或许形象业务逻辑和数据，以便经常使用者轻松上手。
恳求方法：经常出现的HTTP恳求方法有GET（检索资源）和POST（创立资源）。
以下为四个半关键的HTTP动词：GET（检索）、POST（创立）、PUT（降级整个资源）、PATCH（降级资源属性）、DELETE（删除资源）。
此外，还有HEAD（检索元数据）和OPTIONS（检索操作信息）。
RESTful API应应用这些恳求方法启动交互，且URL段中不蕴含任何举措。
版本管理：运行的外围和数据关联相关会始终变动，因此API版本管理至关关键。
修正API或许造成向后不兼容，影响经常使用者。
为确保运行开展并满足经常使用者需求，需在引入新版本的同时保障旧版本的反常访问。
API剖析：继续跟踪客户端经常使用的API版本和端点信息，如每次恳求自增计数器。
跟踪API有助于保障罕用API的有效性。
API Root URL：API根地址对开发者至关关键。
坚持根入口点繁难可提高开发者接受度。
依据运行规模，API可搁置于子域或根域名下，并蕴含相关内容。
端点：端点指向特定资源或资源汇合的URL。
针对每个端点，需列出有效的HTTP动词和端点组合。
过滤器：当客户端恳求对象列表时，前往合乎查问条件的一切对象列表。
过滤器可最小化网络传输并放慢查问结果失掉。
形态码：经常使用适合的HTTP形态码对RESTful API至关关键。
经常出现形态码包括200 OK、201 CREATED、204 NO CONTENT等。
形态码范畴：1xx范畴形态码用于底层HTTP配置，2xx范畴形态码用于成功信息，3xx范畴形态码用于重定向，4xx范畴形态码用于客户端失误，5xx范畴形态码用于主机端失误。
预期前往文档：经常使用不同的HTTP动词执执行作时，生产者须要在前往中失掉某些信息。
典型的RESTful API包括GET、POST、PUT、PATCH、DELETE等操作。
认证：主机需确定启动恳求的用户身份。
OAuth2.0等认证方法可确保客户端安保访问API。
Content Type：大少数API提供JSON数据允许。
前往有效的数据格局可让开发者经常使用盛行的言语和框架启动解析。
超媒体API：超媒体API或许是RESTful API设计的未来。
它经过恳求API根失掉URL列表，每个URL都指向一个汇合，并形容客户端可了解的信息。
文档：API文档对开发者至关关键。
文档应面向一切开发者，确保易于了解，并提供完整的示例恳求和照应主体。
修订：原始的HTTP封装：HTTP恳求和照应都由键值对集组成，包括头部、恳求体、照应体等。
经常使用工具检查原始HTTP封装对API设计至关关键。
restful api接口规范
restful api接口规范如下：
1、协定
API与用户的通讯协定，总是经常使用HTTPs协定。
2、域名
应该尽量将API部署在公用域名之下。
假设确定API很繁难，不会有进一步裁减，可以思考放在主域名下。
3、版本（Versioning）
应该将API的版本号放入URL。
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL繁难和直观。
Github驳回这种做法。
4、门路（Endpoint）
门路又称终点（endpoint），示意API的详细网址。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。
普通来说，数据库中的表都是同种记载的汇合（collection），所以API中的名词也应该经常使用双数。
举例来说，有一个API提供生物园（zoo）的信息，还包括各种生物和雇员的信息，则它的门路应该设计成上方这样。
Restful 格调API的接口设计规范
RESTful架构，其外围在于经过HTTP动词和URL来形容资源及其操作，成功了一种繁复高效的运行程序接口设计格调。
繁难了解，资源在URL中以名词方式展现，动词示意对资源的解决举措。
正确的设计遵照这一准则，而失误的设计则未能充沛执行此规范。
在RESTful格调中，资源被示意为URL地址中的名词，如用户、文章等，经过HTTP动词启动操作。
HTTP动词如GET用于读取资源，POST用于创立资源，PUT用于降级资源，DELETE用于删除资源。
这一设计使得接口的经常使用和了解愈加直观。
失误设计的例子理论会将操作与资源混杂，或许经常使用非规范或不明白的HTTP动词，造成接口难以了解和经常使用。
正确的设计则明晰地将动词与资源分别，经常使用规范HTTP动词启动操作，如GET恳求失掉资源，POST恳求创立资源等。
遵照RESTful规范的接口设计强调形态无反作用，即每次HTTP恳求都应该有明白的照应，并且形态应该是可预测的。
同时，设计应尽量防止经常使用全局形态，确保接口的可测试性和可保养性。
总结而言，RESTful架构经过繁复的URL和规范的HTTP动词成功了一种弱小的、可了解的接口设计格调。
遵照这一规范可以确保接口的高效、稳固和易于保养。
phper