django restful API 代码自动生成_阿里restful接口规范

django restful API 代码自动生成_阿里restful接口规范restful接口规范什么是接口规范?接口规范就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据。如何写接口:接口规范是规范化书写接口的,写接口要写url、响应数据​注:如果将请求参

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

restful接口规范

  什么是接口规范?接口规范就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据。如何写接口:接口规范是规范化书写接口的,写接口要写url、响应数据
​  注:如果将请求参数也纳入考量范围,那就是在写接口文档
 

url

restful接口的url规范,遵循以下6个规范
 

1.用关键字标识接口url

比如登录的接口,可以用下面的url,这样我们阅读的时候,一眼就能看出这个是登录接口

www.baidu.com/login/

注意:我们的URI不应该使用动作来描述,比如createUser
 

2.接口数据安全性决定优先选择https协议

 

3.如果一个接口有多版本存在,需要在url中标识体现

假如我们刚开发一个后台,那第一个版本就是v1

api.baidu.com/v1/

后面接口需要升级,那么就将接口升级为v2

api.baidu.com/v2/

 

4.接口操作的数据源称之为资源,在url中一般采用资源复数形式,一个接口可以概括对该资源的多种操作方式

获取全部书籍

api.baidu.com/books

获取指定的书籍

api.baidu.com/books/(pk)

 

5.请求方式有很多种,用一个url处理如何保证不混乱 – 通过请求方式标识操作资源的方式

获取所有书籍,使用get请求

/books/

增加一本书籍,使用post请求

/books/

删除一本书籍,使用delete请求

/books/(pk)

整体更新一本书籍的内容,使用put请求

/books/(pk)

局部更新一本书籍的一个字段,使用patch请求

/books/(pk)

 

6.资源往往涉及数据的各种操作方式 – 筛选、排序、限制

api.baidu.com/books/?search=jkc&ordering=price&limit=3

 

响应数据

响应数据遵循以下4个规范
 

1.http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有操作数据结果的状态码

status    0(操作资源成功)    1(操作资源失败)    2(操作资源成功,但没匹配结果)

注:资源状态码不像http状态码,一般是后台与前台或者是客户约定的
 

2. 资源的状态码文字提示

status    ok    '账号有误'    '密码有误'    '用户锁定'

 

3. 资源本身

data: {
    业务数据
}

 

4. 不能直接返回的资源(子资源、图片、视频等资源),返回该资源的url链接

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/165780.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • mysql 删除一条数据sql语句_sql删除语句[通俗易懂]

    mysql 删除一条数据sql语句_sql删除语句[通俗易懂]sql删除语句一般简单的删除数据记录用delete就行了,但是如何要删除复杂的外键就不是一条delete删除来实例的,我们本文章先讲一下delete删除,然后再告诉你利用触发器删除多条记录多个表。删除数据库中的数据sql删除语句一般简单的删除数据记录用delete就行了,但是如何要删除复杂的外键就不是一条delete删除来实例的,我们本文章先讲一下delete删除,然后再告诉你利用触发器删除多…

    2022年9月1日
    2
  • Schrodinger分子动力模拟软件与UltraLAB建模工作站配置探讨

    Schrodinger分子动力模拟软件与UltraLAB建模工作站配置探讨Schrodinger2018-1是Schrodinger软件的最新版本,也是目前计算化学领域的领导者,能够为生命科学和材料研究提供软件解决方案和服务。该软件并不是独立,而是一个软件合集包,由maestro、maesrtoelements、materialsscience、bioluminate、knime、canvas、mmshare、aacg、Glide、Impact、Jagua…

    2022年5月25日
    43
  • CentOS7安装VMware Tools

    CentOS7安装VMware ToolsCentOS7安装VMwareTools的具体步骤如下:一、准备工作点击VMware菜单栏【虚拟机】,选择【安装VMwareTools】;如果安装了早期版本的VMwareTools,则菜单项为[更新VMwareTools]查看【虚拟机>设置>硬件>CD/DVD】是否已装载CD虚拟驱动器,如下图二、检查系统是否挂载成功在虚拟机中,以root身份登录客…

    2022年5月26日
    50
  • oracle dba教程视频_数据库中的DBA

    oracle dba教程视频_数据库中的DBA我机器上只有一部分的版本:http://v.youku.com/v_show/id_XMTk3MTgzMzI=.htmlhttp://www.ixdba.net/article/b3/1317.htmlhttp://itboba.com/taxonomy/term/620http://v.youku.com/v_playlist/f2972170o1p9.html

    2025年7月29日
    4
  • 华为数通hcie_通融理赔后需要签协议吗

    华为数通hcie_通融理赔后需要签协议吗Internet组管理协议称为IGMP协议(InternetGroupManagementProtocol),是因特网协议家族中的一个组播协议。该协议运行在主机和组播路由器之间。IGMP包含了IGMPv1、IGMPv2、IGMPv3三个版本,目前正处于由IGMPv2向IGMPv3的过渡阶段。本篇将按照IGMP基本原理、IGMP三个版本、IGMPSnooping几部分对IGMP协议进行介绍。

    2022年9月14日
    2
  • goland激活码3月最新在线激活

    goland激活码3月最新在线激活,https://javaforall.net/100143.html。详细ieda激活码不妨到全栈程序员必看教程网一起来了解一下吧!

    2022年3月15日
    40

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号