`
erichi101
  • 浏览: 11199 次
文章分类
社区版块
存档分类
最新评论

restful api 设计原则

阅读更多

目录

  1. 定义(Definitions)
  2. 数据的设计与抽象化(Data Design and Abstraction)
  3. HTTP动词 (Verbs)
  4. 版本(Versioning)
  5. 分析 (Analytics)
  6. API根路径 (API Root URL)
  7. 路径 (Endpoint)
  8. 信息过滤 (Filtering)
  9. 状态码 (Status Codes)
  10. 文档返回值 (Expected Return Documents)
  11. 身份认证 (Authentication)
  12. 内容形式 (Content Type)
  13. 超媒体 (Hypermedia APIs)
  14. 文档 (Documentation)
  15. 其它:HTTP包文
转载(http://angelbill3.iteye.com/blog/2108785
原文(https://codeplanet.io/principles-good-restful-api-design/
分享到:
评论

相关推荐

    RESTful-API设计原则与规范

    ### RESTful-API设计原则与规范 #### 一、背景与基础概念 RESTful架构作为一种流行的互联网软件架构,因其结构清晰、符合标准、易于理解和扩展等特点而受到广泛青睐。REST(Representational State Transfer)的...

    基于 RESTful 架构的API设计原则和规范.docx

    基于 RESTful 架构的 API 设计原则和规范 RESTful 架构是目前最流行的一种互联网软件架构,它结构清晰、符合标准、易于理解、扩展方便,基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。因此...

    RESTful API设计规范

    ### RESTful API设计规范详解 #### 一、RESTful简介 RESTful是一种广泛应用于Web服务的设计风格,全称为Representational State Transfer(表述性状态转移)。它并非一项具体的技术标准,而是一系列设计原则和约束...

    Spring boot restful api demo

    总结,Spring Boot结合RESTful API设计原则,为开发者提供了快速构建高效、易于维护的Web服务的平台。这个"Spring Boot RESTful API demo"项目展示了如何创建、查询和管理资源的基本步骤。通过实践和扩展,可以实现...

    Laravel开发-restfulapi

    2. RESTful API设计原则 3. 集成OAuth2服务器,实现安全的权限管理 4. 使用Laravel CORS包处理跨域请求 5. 实施API版本控制,确保向后兼容 学习并掌握这些内容,开发者可以构建出高效、安全且易于维护的RESTful API...

    restful api设计

    RESTful API 设计原则: 1. 用名词,不用动词:从“由内而外”角度看待 API 设计,我们试图用 API 实现什么?API 的方向是从应用程序开发人员的角度考虑设计选择。 2. 用名词复数,拒绝抽象:避免使用一个混合模型...

    Golang Gin RESTFul API with SQLite

    在这个项目中,我们将探讨Gin框架的核心特性,RESTful API设计原则,以及SQLite在Go中的应用。 Gin是一个轻量级的HTTP服务器框架,它的核心是基于Gorilla Mux,提供了一个高效的路由系统,允许开发者通过路径、方法...

    RESTful API 设计最佳实践

    以下是对RESTful API设计核心概念的详细解释: 1. **资源**:在RESTful API中,资源是系统中的核心实体,例如“tickets”或“messages”。资源通过唯一的URI(统一资源标识符)进行定位,使得客户端可以通过HTTP...

    RESTFUL_API代码

    1. **RESTful API设计原则**: - **资源定位**:每个资源都有一个唯一的URI(统一资源标识符),通过HTTP方法操作这些URI来实现对资源的操作。 - **无状态**:每次请求都应该包含所有必要的信息,服务器不保存任何...

    Hands-On RESTful API Design Patterns and Best Practices

    1. RESTful API设计原则:包括统一接口原则、无状态通信原则、客户端-服务器分离原则、可缓存原则等。理解这些设计原则是构建RESTful API的基础。 2. 资源的表达和定位:在RESTful API中,每一个可访问的资源都应该...

    基于Python Flask的简易RESTful API接口,可实现基本的前后端分离.zip

    2. **RESTful API设计原则**:了解如何根据RESTful原则设计API,包括状态码的使用、资源的CRUD操作以及URL的规划。例如,使用GET获取资源,POST创建新资源,PUT更新资源,DELETE删除资源。 3. **Flask-RESTful扩展*...

    RESTFul API 接口说明

    - **URI设计原则**: - 尽量保持简单和直观; - 使用资源名称而不是动词; - 对于单一资源,使用 `/resource/{id}` 的形式; - 对于集合资源,使用 `/resources` 或 `/resource` 的形式; - 避免使用描述动作的...

    RESTful Web API Design with Node.JS - Second Edition

    在本书中,Bojinov探讨了RESTful API设计原则,并展示了如何高效地实现它们。本书既适合初学者也适合有经验的开发者,旨在提供实际操作方面的指导。 REST(Representational State Transfer)是一种软件架构风格,...

    基于flask实现RestfulAPi.zip

    2. RESTful API设计原则: - 资源定位:每个资源都有一个唯一的URI(Uniform Resource Identifier)。 - HTTP方法:使用标准的HTTP方法(GET、POST、PUT、DELETE、PATCH等)来表示对资源的操作。 - 状态转移:...

    C#中的RESTful API设计与实现

    本文将详细介绍如何在C#中设计和实现RESTful API,包括关键概念、设计原则、以及实际编码示例。 RESTful API在现代Web开发中扮演着核心角色。通过遵循REST原则和最佳实践,你可以设计和实现强大、灵活且易于维护的...

    RestfulApi服务端.zip

    RestfulApi服务端是现代Web应用开发中常用的一种设计风格,它基于HTTP协议,通过不同的HTTP方法(GET、POST、PUT、DELETE等)来...这个Demo提供了学习和实践的机会,帮助开发者掌握RESTful API的设计原则和实现方法。

    微博情感分析,使用flask制作restful api,毕业设计.zip

    5. **RESTful API设计**:RESTful API设计原则包括使用HTTP动词(GET、POST、PUT、DELETE等)表示操作,使用URI(Uniform Resource Identifier)表示资源,以及使用JSON格式交换数据。这样的API易于理解和使用,适合...

Global site tag (gtag.js) - Google Analytics