如何编写符合rest架构风格的restful?_php restful api 框架

如何编写符合rest架构风格的restful?_php restful api 框架RESTful架构&简单使用Django rest framework

大家好,又见面了,我是你们的朋友全栈君。

 

RESTful架构

 

 

1 什么是REST

REST全称是Representational State Transfer,中文意思是表述性状态转移。 它首次出现在2000年Roy Fielding的博士论文中,Roy Fielding是 HTTP 规范的主要编写者之一。 他在论文中提到:“我这篇文章的写作目的,就是想在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到一个功能强、性能好、适宜通信的架构。REST指的是一组架构约束条件和原则。” 如果一个架构符合REST的约束条件和原则,我们就称它为RESTful架构。

REST本身并没有创造新的技术、组件或服务,而隐藏在RESTful背后的理念就是使用Web的现有特征和能力, 更好地使用现有Web标准中的一些准则和约束。虽然REST本身受Web技术的影响很深, 但是理论上REST架构风格并不是绑定在HTTP上,只不过目前HTTP是唯一与REST相关的实例。 所以我们这里描述的REST也是通过HTTP实现的REST。

 

 

2 理解RestFul

http://www.linuxeye.com/architecture/1713.html

 

如何编写符合rest架构风格的restful?_php restful api 框架
如何编写符合rest架构风格的restful?_php restful api 框架

1、名称

Fielding将他对互联网软件的架构原则,定名为REST,即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。

如果一个架构符合REST原则,就称它为RESTful架构。

要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,它的每一个词代表了什么涵义。如果你把这个名称搞懂了,也就不难体会REST是一种什么样的设计。

2、资源(Resources)

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

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

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

3、表现层(Representation)

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

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

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

4、状态转化(State Transfer)

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

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

客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。

5、综述

综合上面的解释,我们总结一下什么是RESTful架构:

  (1)每一个URI代表一种资源;

  (2)客户端和服务器之间,传递这种资源的某种表现层;

  (3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。

7、误区

RESTful架构有一些典型的设计误区。

最常见的一种设计错误,就是URI包含动词。因为"资源"表示一种实体,所以应该是名词,URI不应该有动词,动词应该放在HTTP协议中。

举例来说,某个URI是/posts/show/1,其中show是动词,这个URI就设计错了,正确的写法应该是/posts/1,然后用GET方法表示show。

如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。比如网上汇款,从账户1向账户2汇款500元,错误的URI是:

补充理解

https://www.cnblogs.com/alex3714/articles/6808013.html

  

 

3.Restful API设计指南

https://www.cnblogs.com/alex3714/articles/6808013.html

 

 

4.认证机制

https://www.cnblogs.com/chinajava/p/5871305.html

 

 

 

简单使用Django rest framework

前期数据库准备

from django.db import models

# Create your models here.

class User(models.Model):
    name=models.CharField(max_length=20,verbose_name="姓名")
    passwd=models.CharField(max_length=30,verbose_name="密码")

 

rest_view.py

如何编写符合rest架构风格的restful?_php restful api 框架
如何编写符合rest架构风格的restful?_php restful api 框架

from Test import models
from Test import rest
from rest_framework import  viewsets

# ViewSets define the view behavior.
class UserViewSet(viewsets.ModelViewSet):
    #把数据取出来
    queryset = models.User.objects.all()
    # 让数据进行序列化
    serializer_class = rest.UserSerializer

视图函数

  

rest.py

如何编写符合rest架构风格的restful?_php restful api 框架
如何编写符合rest架构风格的restful?_php restful api 框架

#用来序列化数据
from Test import models
from rest_framework import serializers

# Serializers define the API representation.
class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = models.User
        fields = ('name','passwd')

序列化

  

urls.py

如何编写符合rest架构风格的restful?_php restful api 框架
如何编写符合rest架构风格的restful?_php restful api 框架

from django.conf.urls import url, include
from django.contrib import admin
from django.urls import path
from Test import  rest_view
from rest_framework import routers


# Routers provide an easy way of automatically determining the URL conf.
router = routers.DefaultRouter()
router.register(r'users',rest_view.UserViewSet)

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
# urlpatterns = [
#
#     url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
# ]

urlpatterns = [
    path('admin/', admin.site.urls),
    url(r'^api/', include(router.urls)),
]

路由

 

 

1.把数据从数据库中取出来,并序列化,创建一个负责序列化的类

2.将数据库里的数据,交给序列化的类去进行序列化

3.将学校返回给前端

  

 更多使用

 http://www.cnblogs.com/alex3714/articles/7131523.html

 https://www.django-rest-framework.org/

转载于:https://www.cnblogs.com/-wenli/p/10540147.html

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

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

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


相关推荐

  • Windows10下安装Anaconda、Pycharm、Tensorflow-gpu,并在Pycharm中配置Tensorflow

    Windows10下安装Anaconda、Pycharm、Tensorflow-gpu,并在Pycharm中配置TensorflowWindows10下安装Anaconda、Pycharm、Tensorflow-gpu,并在Pycharm中配置TensorflowPyCharm是一款功能强大的Python编辑器,其提供了一个带编码补全,代码片段,支持代码折叠和分割窗口的智能、可配置的编辑器,可帮助用户更快更轻松的完成编码工作。用户可使用其编码语法,错误高亮,智能检测以及一键式代码快速补全建议,使得编码更优化。所以我一般推荐使用Pycharm进行python代码编辑。但是Anaconda通过管理工具包、开发环境、Python

    2022年8月29日
  • ping和tracert的原理_ping和tracert的作用是什么

    ping和tracert的原理_ping和tracert的作用是什么ping程序是利用icmp的回复请求来探测远端主机是否可达。(并不能继续判断端口是否可达。要想查看端口,就要使用扫描器了。)win2000里的网络库里已经提供网络函数库(icmp.dll)可以实现利用icmp来探测远端主机。相比起使用管道来读ping的结果,或者嵌入ping源码,这个是最简单的方法了(没办法,人懒)。ping其实还有一个R选项,用来记录经过的路由,以前一直不知道。(pingww

    2022年9月25日
  • 《FFmpeg从入门到精通》读书笔记(一)

    《FFmpeg从入门到精通》读书笔记(一)写在前面最近在读《FFmpeg从入门到精通》这本书,结合着雷神的博客,学习音视频的知识~在学习的过程中,也记录了一些摘要。因为是边看边记的,所以一些要点在看到后面的时候,需要反过来整理前面的。我用有道云笔记写的markdown没法加图片,所以就先把这部分发了出来。后续会针对内容和排版一步步的优化,如果你被这凌乱的内容辣到了眼睛,请谅解哈哈哈~2019.06.18第一章+第二章知识点(未…

    2022年6月26日
  • RestSharp_简单搜索怎么使用

    RestSharp_简单搜索怎么使用C#使用restsharp调用接口

    2022年9月4日
  • EL表达式判断Map是否为空和map的取值[通俗易懂]

    EL表达式判断Map是否为空和map的取值[通俗易懂]判断Map是否为空1.在JSP页面中引入sun的核心标签库   @ taglib uri=”http://java.sun.com/jstl/core_rt” prefix=”c” %>2.在JSP页面中引入sun的函数标签库   @ taglib uri=”http://java.sun.com/jsp/jstl/functions”  prefix=”

    2022年6月24日
  • ARMv9刷屏——号称十年最大变革,Realm机密计算技术有什么亮点?

    ARMv9刷屏——号称十年最大变革,Realm机密计算技术有什么亮点?作者/乾越编辑/芹菜出品/云巅论剑ARMv9的新闻刷屏了。ARMv9号称十年以来最重大变革,因此让我们看下ARMv9中机密计算相关的新特性Realm。(注:本文是对IntroducingtheConfidentialComputeArchitecture的部分翻译和个人注解,本文图均来自anandtech.com网站。)背景在过去的几年里,我们看到安全问题和硬件安全漏洞已经成为了新闻热点。许多处理器侧信道漏洞,如幽灵、熔毁以及与它们有关的侧通道攻击,都表明…

    2022年6月22日

发表回复

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

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