开始一个最简单的RESTful API项目

最近在网易云课堂上看一些视频,给大家推荐一个讲Spring Boot的视频https://study.163.com/course/courseMain.htm?courseId=1005213034,老师讲的很不错。在学习的时候我也会做一些笔记,方便日后巩固。

什么是RESTful API?

REST是Representational State Transfer的缩写。它的特点是:

  • 所有的东西都是资源,所有操作都通过对资源的增删改查(CRUD)实现
  • 对资源的增删改查对应对URL的操作(POST, DELETE, PUT, GET)
  • 无状态的,所谓无状态即所有的资源都可以URI定位,而且这个定位与其他资源无关,也不会因为其他资源的变化而变化。

用一句话概括就是:URL定位资源,用HTTP动词(GET,POST,PUT,DELETE)描述操作。

  • Resource:资源,即数据
  • Representational:某种表现形式,比如用JSON,XML,JPEG等
  • State Transfer:状态变化。通过HTTP动词实现。

所以RESTful API就是REST风格的API。 那么在什么场景下使用RESTful API呢?在当今的互联网应用的前端展示媒介很丰富。有手机、有平板电脑还有PC以及其他的展示媒介。那么这些前端接收到的用户请求统一由一个后台来处理并返回给不同的前端肯定是最科学和最经济的方式,RESTful API就是一套协议来规范多种形式的前端和同一个后台的交互方式。

RESTful API由后台也就是SERVER来提供前端来调用。前端调用API向后台发起HTTP请求,后台响应请求将处理结果反馈给前端。也就是说RESTful 是典型的基于HTTP的协议。

URI命名

什么是Spring Boot?

Spring Boot 的目的是提供一组工具,以便快速构建容易配置的 Spring 应用程序,不用像Spring一样,写一个Hello World都要配置一大堆。Spring Boot是不需要配置XML的,且它自带了一个嵌入式的web服务器。引用Spring Boot官网的介绍:

“ Spring Boot 使您能轻松地创建独立的、生产级的、基于 Spring 且能直接运行的应用程序。我们对 Spring 平台和第三方库有自己的看法,所以您从一开始只会遇到极少的麻烦。”

最简单的Spring Boot项目

  1. 首先前往https://start.spring.io

    课时4.1

  2. 从IDEA中导入项目,导入时选中MAVEN的.pom文件,后面一路next就好


    IDEA import
  3. 导入后的项目结构:

    项目结构
  4. 在cn.luxiaofen.test包下新建一个TvseriesController类


    课时3.1
  5. 在浏览器中测试,地址是http://localhost:8080/tvseries

    课时3.2

一个简单的RESTful API

一般项目不会像上面所说的这么简单,返回的应该是一个对象不是一个Map。

  1. 在cn.luxiaofen.test新建一个TvseriesDto类


    TvSeriesDto
  2. 修改Controller中的方法:


    修改方法
  3. 到浏览器中去验证


    课时4.3
  4. 如果希望修改时间显示,需要修改JSON的一些参数

日期型转JSON格式

  • 可以在属性上增加 @JsonFormat(timezone=“GMT+8”, pattern=“yyyy-MM-dd”) 或 @JsonFormat(shape = JsonFormat.Shape.NUMBER)
  • 全局修改可以在application.yml
    spring
       jackson:
       date-format: yyyy-MM-dd  #如果使用字符串型表示,用这行设置格式
       timezone: GMT+8 #改成东八区的时间
       serialization:
       write-dates-as-timestamps: true  #使用数值timestamp表示日期
    
  • 两个方法可以一起使用,注解形式会优先

在配置文件中修改JSON格式

  1. 将.properties文件改成.yml文件,看起来会比较方便


    课时4.4
  2. 修改.yml文件


    课时4.5
  3. 重启Spring Boot,到浏览器中查看


    课时4.6

参考博文:
https://blog.csdn.net/hjc1984117/article/details/77334616

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容