精华内容
下载资源
问答
  • Restful API 接口规范

    千次阅读 2020-09-09 22:35:23
    文章目录Restful API 接口规范背景什么是RESTful架构呢?RESTful API 设计 Restful API 接口规范 暑假期间接触到实际开发项目对开发过程中遇到的Restful接口规范存在疑惑,由于当时主要目的是尽快本地运行项目,尝试...

    Restful API 接口规范

    暑假期间接触到实际开发项目对开发过程中遇到的Restful接口规范存在疑惑,由于当时主要目的是尽快本地运行项目,尝试开发,没有对这个接口规范深入了解。趁着最近时间比较轻松,逐步学习Restful规范

    背景

    越来越多的人开始意识到,网站即软件,而且是一种新型的软件。

    这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。

    网站开发,完全可以采用软件开发的模式。但是传统上,软件和网络是两个不同的领域,很少有交集;软件开发主要针对单机环境,网络则主要研究系统之间的通信。互联网的兴起,使得这两个领域开始融合,现在我们必须考虑,如何开发在互联网环境中使用的软件。
    img

    RESTful架构,就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。

    什么是RESTful架构呢?

    REST(Representational State Transfer)

    REST的名称"表现层状态转化"中,省略了主语。“表现层"其实指的是"资源”(Resources)的"表现层"。

    资源(Resources)

    • 所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。

    • 所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。

    表现层(Representation)

    "资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。

    比如,文本可以用txt格式表现,也可以用HTML格式XML格式JSON格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。

    URL只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用AcceptContent-Type字段指定,这两个字段才是对"表现层"的描述。

    状态转化(State Transfer)

    访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。

    互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。

    客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GETPOSTPUTDELETE。四个表示操作方式对应对应四种基本操作

    • GET 获取资源
    • POST 新建资源
    • PUT 更新资源
    • DELETE 删除资源

    在这里插入图片描述

    综合上面,RESTful架构的内容:

    1. 每一个URI代表一种资源;
    2. 客户端和服务器之间,传递这种资源的某种表现层;
    3. 客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。

    RESTful API 设计

    1. API与用户的通信协议

      采用HTTPs协议

    2. 域名

      api关键字标识接口url

      示例:

       # 应该尽量将API部署在专用域名之下。
       # 表示前后端数据交互
       https://api.example.com
       
       # 应该尽量将API部署在专用域名之下。
       https://example.org/api/
    
    1. 路径

      路径又称"终点"(endpoint),表示API的具体网址。

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

    2. HTTP动词

      对于资源的具体操作类型,由HTTP动词表示。

       GET(SELECT):从服务器取出资源(一项或多项)。
       POST(CREATE):在服务器新建一个资源。
       PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
       PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
       DELETE(DELETE):从服务器删除资源。
    

    不常用

       HEAD:获取资源的元数据。
       OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。
    
    1. 状态码
       200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
       201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
       202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
       204 NO CONTENT - [DELETE]:用户删除数据成功。
       
       
       301:永久重定向
       302:暂时重定向
       
       
       400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
       401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
       403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
       404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
       406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
       410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
       422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
       
       
       500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
    
    1. 错误处理

      状态码是4xx时,应返回错误信息,error当做key。

       {
           error: "Invalid API key"
       }
    
    1. 返回结果格式

      尽量采用json格式避免XML格式

       GET /collection:返回资源对象的列表(数组)
       GET /collection/resource:返回单个资源对象
       POST /collection:返回新生成的资源对象
       PUT /collection/resource:返回完整的资源对象
       PATCH /collection/resource:返回完整的资源对象
       DELETE /collection/resource:返回一个空文档
    
    展开全文
  • RESTful api接口规范

    千次阅读 2019-03-15 11:03:29
    应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。 https://example.org/api/ api版本控制 应该将API的版本号放入URL。 ...

    域名

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

    https://api.example.com

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

    https://example.org/api/

    api版本控制

    应该将API的版本号放入URL。

    https://api.example.com/v{n}/

    v{n} n代表版本号,分为整形和浮点型

    整形的版本号: 大功能版本发布形式;具有当前版本状态下的所有API接口 ,例如:v1,v2

    浮点型:为小版本号,只具备补充api的功能,其他api都默认调用对应大版本号的api 例如:v1.1 v2.2

    API 路径规则

    路径又称"终点"(endpoint),表示API的具体网址。

    在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。

    举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。

    
    https://api.example.com/v1/products
    
    https://api.example.com/v1/users
    
    https://api.example.com/v1/employees
    
    

    HTTP请求方式

    对于资源的具体操作类型,由HTTP动词表示。

    常用的HTTP动词有下面四个(括号里是对应的SQL命令)。

    • GET(SELECT):从服务器取出资源(一项或多项)。

    • POST(CREATE):在服务器新建一个资源。

    • PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。

    • DELETE(DELETE):从服务器删除资源。

    下面是一些例子。

    GET /product:列出所有商品
    
    POST /product:新建一个商品
    
    GET /product/ID:获取某个指定商品的信息
    
    PUT /product/ID:更新某个指定商品的信息
    
    DELETE /product/ID:删除某个商品
    
    GET /product/ID/purchase :列出某个指定商品的所有投资者
    
    get /product/ID/purchase/ID:获取某个指定商品的指定投资者信息
    

    过滤信息

    如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。

    下面是一些常见的参数。

    ?limit=10:指定返回记录的数量

    ?offset=10:指定返回记录的开始位置。

    ?page=2&per_page=100:指定第几页,以及每页的记录数。

    ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。

    ?producy_type=1:指定筛选条件

    注意点

    • 资源路径

    对于rest资源的定义,即URL的定义,是最重要的;想要设计出优雅的、易读的rest 接口,其实还是听不容易的。

    • URL中不能有动词

    在Restful架构中,每个网址代表的是一种资源,所以网址中不能有动词,只能有名词,动词由HTTP的 get、post、put、delete 四种方法来表示。

    • URL结尾不应该包含斜杠“/”

    这是作为URL路径中处理中最重要的规则之一,正斜杠(/)不会增加语义值,且可能导致混淆。REST API不允许一个尾部的斜杠,不应该将它们包含在提供给客户端的链接的结尾处。

    • 正斜杠分隔符”/“必须用来指示层级关系
      rul的路径中的正斜杠“/“字符用于指示资源之间的层次关系。

    例如:

    http://api.user.com/schools/grades/classes/boys //学校中所有的男生
    http://api.college.com/students/3248234/courses //检索id为3248234的学生学习的所有课程的清单。

    • URL路径名词均为复数
      为了保证url格式的一致性,建议使用复数形式。

    • RESTful API对资源的操作
      对于rest api资源的操作,由HTTP动词表示

    参考文献

    Restful api接口规范

    展开全文
  • REST它是一种使用URL来定位资源,使用HTTP请求描述操作的Web服务规范,本资源包含RESTful简介、设计原则、通用说明、规范细则、接口管理说明。
  • RESTful API接口规范

    2020-07-06 15:13:32
    api关键字来标识接口url https://api.example.com https://example.org/api/ 注:看到api字眼,就代表该请求url链接是完成前后台数据交互的 版本 \1. 将版本信息放在URL中,如: ​ ...

    域名

    用api关键字来标识接口url

     

    https://api.example.com

     

    https://example.org/api/

     

    注:看到api字眼,就代表该请求url链接是完成前后台数据交互的

     

    版本

    \1. 将版本信息放在URL中,如:

     

    ​ https://api.example.com/v1/

     

    ​ https://api.example.com/v2/

     

    ​ v1,v2代表不同数据版本的提现,前提是一种数据资源有多个版本

     

    \2. 将版本信息放在请求头中。

     

    url路径

    视网络上任何东西都是资源,均使用名词表示(一般为复数形式)

     

    https://api.example.com/v1/zoos

     

    https://api.example.com/v1/animals

     

    https://api.example.com/v1/employees

     

    在url链接中奖励不要出现操作资源的动词

     

    ​ 错误示范:https://api.baidu.com/delete-user

     

    特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义

     

    https://api.baidu.com/place/search

    https://api.baidu.com/login

    method请求方式

    GET :从服务器取出资源(一项或多项)

     

    POST :在服务器新建一个资源

     

    PUT :在服务器更新资源(客户端提供改变后的完整资源)

     

    PATCH :在服务器更新资源(客户端提供改变的属性)

     

    DELETE :从服务器删除资源

     

    过滤

    通过在url上传参的形式传递搜索条件

     

    https://api.example.com/v1/zoos?limit=10:指定返回记录的数量

     

    https://api.example.com/v1/zoos?offset=10:指定返回记录的开始位置

     

    https://api.example.com/v1/zoos?page=2&per_page=100:指定第几页,以及每页的记录数

     

    https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序

     

    https://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件

     

    状态码

    200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。

    201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。

    202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)

    204 NO CONTENT - [DELETE]:用户删除数据成功。

     

     

    301:永久重定向

    302:暂时重定向

     

     

    400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。

    401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。

    403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。

    404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。

    406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。

    410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。

    422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。

     

     

    500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

    错误处理

    状态码是4xx时,应返回错误信息,error当做key。    

    {
    
        error: "Invalid API key"
    
    }

    返回结果

    针对不同操作,服务器向用户返回的结果应该符合以下规范

     

    GET /collection:返回资源对象的列表(数组)

    GET /collection/resource:返回单个资源对象

    POST /collection:返回新生成的资源对象

    PUT /collection/resource:返回完整的资源对象

    PATCH /collection/resource:返回完整的资源对象

    DELETE /collection/resource:返回一个空文档

    {
    
        "status": 0,
    
        "msg": "ok",
    
        "results":[
    
            {
    
                "name":"肯德基(罗餐厅)",
    
                "location":{
    
                    "lat":31.415354,
    
                    "lng":121.357339
    
                },
    
                "address":"月罗路2380号",
    
                "province":"上海市",
    
                "city":"上海市",
    
                "area":"宝山区",
    
                "street_id":"339ed41ae1d6dc320a5cb37c",
    
                "telephone":"(021)56761006",
    
                "detail":1,
    
                "uid":"339ed41ae1d6dc320a5cb37c"
    
            }
    
            ...
    
            ]
    
    }

    Hypermedia API

    RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。

    {"link": {
    
      "rel":   "collection https://www.example.com/zoos",
    
      "href":  "https://api.example.com/zoos",
    
      "title": "List of zoos",
    
      "type":  "application/vnd.yourformat+json"
    
    }}

     

    展开全文
  • Restful API接口规范

    万次阅读 多人点赞 2019-04-28 16:18:11
    RESTful API 接口应该提供参数,过滤返回结果。 【GET】 /{version}/{resources}/{resource_id}?offset=0&limit=20   5 、响应参数 JSON格式(code、data、msg)   6 、状态码 使用适合的...

    简介

    REST:英文representational state transfer直译为表现层状态转移,或者表述性状态转移;Rest是web服务的一种架构风格,一种设计风格,是一种思想;同时Rest不是针对某一种编程语言的。

    以webService为例通俗解释。

    非Rest设计,以往我们都会这么写:

    http://localhost:8080/admin/getUser (查询用户)

    http://localhost:8080/admin/addUser (新增用户)

    http://localhost:8080/admin/updateUser (更新用户)

    http://localhost:8080/admin/deleteUser (删除用户)

    总结:以不同的URL(主要为使用动词)进行不同的操作。

     

    Rest架构:

    GET http://localhost:8080/admin/user (查询用户)

    POST http://localhost:8080/admin/user (新增用户)

    PUT http://localhost:8080/admin/user (更新用户)

    DELETE http://localhost:8080/admin/user (删除用户)

    总结:URL只指定资源,以HTTP方法动词进行不同的操作。用HTTP STATUS/CODE定义操作结果。

     

    Restful:遵守了rest风格的web服务便可称为Restful。

     

    为什么需要Restful?

     

    URL具有很强可读性的,具有自描述性

    规范化请求过程和返回结果

    资源描述与视图的松耦合

    可提供OpenAPI,便于第三方系统集成,提高互操作性

    提供无状态的服务接口,降低复杂度,可提高应用的水平扩展性

     

    /版本号/资源路径

    /v1/tags/{tag_id}

    /v1/users?[&keyword=xxx][&enable=1][&offset=0][&limit=20]

     

    1、版本号

    命名版本号可以解决版本不兼容问题,在设计 RESTful API 的一种实用的做法是使用版本号。一般情况下,我们会在 url 中保留旧版本号,并同时兼容多个版本

    【GET】  /v1/users/{user_id}  // 版本 v1 的查询用户列表的 API 接口

    【GET】  /v2/users/{user_id}  // 版本 v2 的查询用户列表的 API 接口

     

    2、资源路径

    URI 不能包含动词,只能是名词(命名名词的时候,要使用小写、数字及下划线来区分多个单词)。

    资源的路径应该从根到子依次如下:

    /{resources}/{resource_id}/{sub_resources}/{sub_resource_id}/{sub_resource_property}

    【POST】  /v1/users/{user_id}/roles/{role_id} // 添加用户的角色

     

    有的时候,当一个资源变化难以使用标准的 RESTful API 来命名,可以考虑使用一些特殊的 actions 命名。

    /{resources}/{resource_id}/actions/{action}

    【PUT】  /v1/users/{user_id}/password/actions/modify // 密码修改

     

    3、请求方式

    【GET】          /users                # 查询用户信息列表

    【GET】          /users/1001           # 查看某个用户信息

    【POST】         /users                # 新建用户信息

    【PUT】          /users/1001           # 更新用户信息(全部字段)

    【PATCH】        /users/1001           # 更新用户信息(部分字段)

    【DELETE】       /users/1001           # 删除用户信息

     

    【PATCH】一般不用,用【PUT】

     

    4、查询参数

    RESTful API 接口应该提供参数,过滤返回结果。

    【GET】  /{version}/{resources}/{resource_id}?offset=0&limit=20

     

    5、响应参数

    JSON格式(code、data、msg)

     

    6、状态码

    使用适合的状态码很重要,而不应该全部都返回状态码 200

    状态码,可根据以下标准按照项目扩展自身状态码:

    200~299段 表示操作成功:

    200 操作成功,正常返回

    201 操作成功,已经正在处理该请求

    300~399段 表示参数方面的异常

    300 参数类型错误

    301 参数格式错误

    302 参数超出正常取值范围

    303 token过期

    304 token无效

    400~499段 表示请求地址方面的异常:

    400 找不到地址

    500~599段 表示内部代码异常:

    500 服务器代码异常

     

    7、完整事例

    UserController.java

     

     

    @RestController(/v1)

    @API(tag=”用户相关接口”)

    public class UserController {

     

        @Autowired

        private UserJPARepository userJPARepository;

     

        /**

         * 查询用户列表

         * @return

         */

        @GetMapping(value = "/user")

        public List<User> findUserList(){

            return userJPARepository.findAll();

        }

     

        /**

         * 根据Id查询一个用户

         * @param id

         * @return

         */

        @GetMapping(value = "/user/query/{id}")

        public User findUserOne(@PathVariable("id") Integer id){

            return userJPARepository.findOne(id);

        }

     

        /**

         * 添加用户

         * @param name

         * @param age

         * @param country

         * @return

         */

     

        @PostMapping(value = "/user")

        public User addUser(@RequestParam("name") String name, @RequestParam("age") int age,

                            @RequestParam("country") String country){

            User user = new User();

            user.setName(name);

            user.setAge(age);

            user.setCountry(country);

            return userJPARepository.save(user);

        }

     

        /**

         * 删除用户

         * @param id  用户编号

         * @return

         */

        @DeleteMapping(value = "/user/{id}")

        public  List<User> deleteUser(@PathVariable("id") Integer id){

            userJPARepository.delete(id);

            return userJPARepository.findAll();

        }

     

        /**

         * 更新用户

         * @param id

         * @param name

         * @param age

         * @param country

         * @return

         */

        @PutMapping(value = "/user/{id}")

        public User updateUser(@PathVariable("id") Integer id, @RequestParam("name") String name,

                               @RequestParam("age") int age, @RequestParam("country") String country){

            User user = userJPARepository.findById(id);

            user.setName(name);

            user.setAge(age);

            user.setCountry(country);

            return userJPARepository.save(user);

        }

     

        /**

         * 根据国家查询用户

         * @param country

         * @return

         */

        @GetMapping(value = "/user/{country}")

        public List<User> findByCountry(@PathVariable("country") String country){

            return userJPARepository.findByCountry(country);

        }

    }

     

    展开全文
  • RESTFul API 接口说明

    2018-11-05 02:10:50
    restful api 接口说明. 总结 restful api 语法知识和常用的状态码含义.
  • RESTful API设计规范

    2019-03-15 10:11:31
    RESTful API设计规范
  • 开发restful接口应该遵循统一的规范,保持规范的统一才能方便维护和应用
  • api = Redprint ( 'book' ) - - - - - - - - - - - - - - - - - libs redprint . py - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - class RedPrint ( ) : def __init__ ( self ,...
  • RESTFUL API 接口规范

    2020-08-01 13:20:54
    RESTFUL适用于移动互联网厂商作为业务使能接口的场景,实现第三方OTT调用移动网络资源的功能,动作类型为新增、变更、删除所调用资源。 起源 描述了一个架构样式的网络系统,比如 web 应用程序。它首次出现在 ...
  • 关于各大平台API为什么不使用RESTful的风格来进行开发呢,比如:URL命名格式,只有post get 并没有put delete ,更加没有用到HttpStatusCode ,他们是出于什么目的没有遵循这样的面向资源的开发和设计模型?...
  • restful api接口规范

    2020-12-01 10:49:36
    api关键字来标识接口url https://api.example.com https://example.org/api/ 注:看到api字眼,就代表该请求url链接是完成前后台数据交互的 版本 \1. 将版本信息放在URL中,如: ​ https://api.example.com/v1/ ...
  • restful API接口规范

    千次阅读 2017-08-29 11:23:33
    前后端分离开发,有统一的接口规范会比较的方便,restful API应运而生了。 一、协议 API与用户的通信协议,总是使用HTTPs协议。 二、域名 应该尽量将API部署在专用域名之下。 https://api.example.com 三、版本 ...
  • RESTful API接口设计标准及规范

    万次阅读 多人点赞 2019-01-12 11:42:10
    RESTful发展背景及简介 网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板...RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。 REST(Representational Stat...
  • 核心:面向资源设计的API 解决问题: 降低开发的复杂性 提高系统的可伸缩性 例如:设计一套API,为多个终端服务。 设计概念和准则 网络上的所有事物都可以被抽象为资源 每一个资源都有唯一的资源标识,对资源的...
  • Restful Api接口规范

    千次阅读 2017-12-05 18:32:44
    最近换了一家新公司,新公司用微服务架构开发,要求接口都用Restful规范,获取简单资源一般都好定义,例如:一个申请接口 url是 /applications,增删改查,用post,delete,put,get方法,但是其他的接口命名一直找不到...
  • RestFul API接口规范

    2019-01-28 12:03:44
    整体规范建议采用RESTful 方式来实施 协议: API与用户的通信协议,总是使用HTTPS协议,确保交互数据的传输安全。 域名: 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单,不会有...
  • Restful API 接口规范、django-rest-framework框架 问题:什么是API? 答:API是接口,提供url. 接口有两个用途: 为别人提供服务,前后端分离。 为什么使用前后端分离? 答:主要为了数据的解耦,提高...
  • GET:获取数据 POST:添加数据 PUT:更新数据 DELETE:删除数据
  • RESTful API接口设计标准及规范

    千次阅读 2020-05-24 17:23:46
    RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。 REST(Representational State Transfer)表述性状态转换,REST指的是一组架构约束条件和原则。 如果一个架构符合REST的约束条件
  • RESTful API接口设计标准及规范(一)

    千次阅读 2019-05-06 18:18:30
    RESTful发展背景及简介 网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板...RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。 REST(Representational S...
  • 规范要点: 1、列表查询:尽量使用查询参数代替路径中的实体导航,如GET /animals?zoo=1&area=3; 2、对象查询:GET /animal/1 3、保存对象:POST /animal 4、修改对象:PUT /animal/1 5、删除对象:DELETE...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 24,693
精华内容 9,877
关键字:

restfulapi接口规范