Restful接口文档规范(restful)

Restful接口文档规范

restful api接口规范如下：协议 API与用户的通信协议，总是使用HTTPs协议。域名 应该尽量将API部署在专用域名之下。如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

关于RESTful的六个限制

1、API不需要1xx状态码 API 返回的数据格式，不应该是纯文本，而应该是一个 *** ON 对象，因为这样才能返回标准的结构化数据。

2、RESTful的实现：RESTful Web 服务的 Java 框架有两个 Java 框架可以帮助构建 RESTful Web 服务。erome Louvel 和 Dave Pawson 开发的 Restlet(见 参考资料)是轻量级的。

3、而不是资源的状态。Restful风格的无状态约束要求服务器不保存请求状态，如果确实需要维持用户状态，也应由客户端负责。传递user credentials 是Restful的，而传递sessionID是unRestful的，因为session信息保存在服务器端。

4、这个限制是特定的浏览器及服务器对它的限制。这里注意一个小点，URL路径是对大小写敏感的，例如：/users 和 /Users 是两个接口哦，但是我们规定URL全部小写。

Restful协议

1、Representational State Transfer， 是一种软件架构风格，提供一系列限制指导，用于更好的创建 web service 。 符合REST 架构风格的web service 称为Restful web service。

2、在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。

3、RESTfulAPIRESTfulAPI是目前更流行的API协议之一。它基于HTTP协议，并以资源为中心，通过HTTP请求进行状态转移。RESTfulAPI具有良好的可扩展性和兼容性，并且与众多编程语言和平台兼容，因此适用于大多数应用场景。

REST和RESTFUL

RESTFUL，是指遵守rest规则的web服务，restful是一种ROA(Resource Oriented Architecture，面向资源的架构)，restful的核心概念就是资源（Resource）。

REST ( REpresentational State Transfer ) 首字母的缩写， ≠ rest。REST是一种架构风格，是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。

就是用URL定位资源，用HTTP描述操作。简单理解二 URL定位资源，用HTTP动词(GET，POST，DELETE，DETC)描述操作。官方定义 一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。

REST描述的是在 *** 中client和server的一种交互形式；REST本身不实用，实用的是如何设计 RESTful API（REST风格的 *** 接口）； Server提供的RESTful API中，URL中只使用名词来指定资源，原则上不使用动词。

简单的说：RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构。资源的地址 在web中就是URL （统一资源标识符）资源是REST系统的核心概念。

那RESTful到底是什么呢？简单的讲，它是：一种架构设计风格，提供了设计原则和约束条件，而不是架构。而满足这些约束条件和原则的应用程序或设计就是 RESTful架构或服务。

restful是什么意思

1、RESTFUL是一种 *** 应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或 *** ON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动 *** 资源的功能，动作类型为新增、变更、删除所调用资源。

2、简单的说：RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构。资源的地址 在web中就是URL （统一资源标识符）资源是REST系统的核心概念。

3、那RESTful到底是什么呢？简单的讲，它是：一种架构设计风格，提供了设计原则和约束条件，而不是架构。而满足这些约束条件和原则的应用程序或设计就是 RESTful架构或服务。

4、RESTful API就是REST风格的 *** 接口，REST描述的是在 *** 中client和server的一种交互形式；REST本身不实用，实用的是如何设计。Server提供的RESTful API中，URL中只使用名词来指定资源，原则上不使用动词。

5、RESTful架构有一些典型的设计误区。最常见的一种设计错误，就是URI包含动词。因为资源表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。

6、REST 可以看成一种服务器接口设计的模式pattern。它的全称是 RE presentational S tate T ransfer。它的意思就是说，服务器根据前端的请求，返回给可展示的资源状态。

免责声明
           本站所有信息均来自互联网搜集
1.与产品相关信息的真实性准确性均由发布单位及个人负责，
2.拒绝任何人以任何形式在本站发表与中华人民共和国法律相抵触的言论
3.请大家仔细辨认！并不代表本站观点,本站对此不承担任何相关法律责任！
4.如果发现本网站有任何文章侵犯你的权益,请立刻联系本站站长[ *** :775191930]，通知给予删除