第 4 章 资源操作

4.5 创建资源

由于创建资源的 Id 会在服务端生成,因此在创建资源时,不建议使用与获取数据时相同的 DTO,而要单独创建一个新的 DTO 类,并通过数据注解特性对相应 的属性做限制

namespace Library.API.Models
{
public class AuthorForCreationDto
{
[Required(ErrorMessage = "必须提供姓名")]
[MaxLength(20, ErrorMessage = "姓名的最大长度为20个字符")]
public string Name { get; set; } public int Age { get; set; } [EmailAddress(ErrorMessage = "邮箱的格式不正确")]
public string Email { get; set; }
}
}

在 IAuthorRepository 添加用于资源添加的方法

void AddAuthor(AuthorDto author);

并在 AuthorMockRepository 中实现

public void AddAuthor(AuthorDto author)
{
author.Id = Guid.NewGuid();
LibraryMockData.Current.Authors.Add(author);
}

接着在 AuthorController 中添加用于创建 Author 的 Action

[HttpPost]
public IActionResult CreateAuthor(AuthorForCreationDto authorForCreationDto)
{
var authorDto = new AuthorDto
{
Name = authorForCreationDto.Name,
Age = authorForCreationDto.Age,
Email = authorForCreationDto.Email
}; AuthorRepository.AddAuthor(authorDto); // 返回201 Created 状态码,并在响应消息头中包含 Location 项,它的值是新创建资源的 URL
// 第一个参数是要调用 Action 的路由名称
// 第二个参数是包含要调用 Action 所需要参数的匿名对象
// 最后一个参数是代表添加成功后的资源本身
return CreatedAtRoute(nameof(GetAuthor), new {authorId = authorDto.Id}, authorDto);
}

由于 CreatedAtRoute 方法要生成指向 GetAuthor 方法的 URL,因此还需要为这个 Action 定义一个路由名称

[HttpGet("{authorId}", Name = nameof(GetAuthor))]
public ActionResult<AuthorDto> GetAuthor(Guid authorId)

创建子级资源,创建 DTO,在 IBookRepository 中接口添加方法,在 BookMockRepository 中实现类实现接口方法

namespace Library.API.Models
{
public class BookForCreationDto
{
public string Title { get; set; }
public string Description { get; set; }
public int Pages { get; set; }
}
} void AddBook(BookDto book); public void AddBook(BookDto book)
{
LibraryMockData.Current.Books.Add(book);
}

在 BookController 添加 Action

[HttpPost]
public IActionResult AddBook(Guid authorId, BookForCreationDto bookForCreationDto)
{
if (!AuthorRepository.IsAuthorExists(authorId))
{
return NotFound();
} var newBook = new BookDto
{
Id = Guid.NewGuid(),
Title = bookForCreationDto.Title,
Description = bookForCreationDto.Description,
Pages = bookForCreationDto.Pages,
AuthorId = authorId
}; BookRepository.AddBook(newBook); return CreatedAtRoute(nameof(GetBook), new {authorId = authorId, bookId = newBook.Id}, newBook);
}

同样为 GetBook 方法指定路由名称

[HttpGet("{bookId}", Name = nameof(GetBook))]
public ActionResult<BookDto> GetBook(Guid authorId, Guid bookId)

4.6 删除资源

在 IBookRepository 中接口添加方法,在 BookMockRepository 中实现类实现接口方法

void DeleteBook(BookDto book);

public void DeleteBook(BookDto book)
{
LibraryMockData.Current.Books.Remove(book);
}

在 BookController 添加 Action

[HttpDelete("{bookID}")]
public IActionResult DeleteBook(Guid authorId, Guid bookId)
{
if (!AuthorRepository.IsAuthorExists(authorId))
{
return NotFound();
} var book = BookRepository.GetBookForAuthor(authorId, bookId);
if (book == null)
{
return NotFound();
} BookRepository.DeleteBook(book);
return NoContent();
}

删除父与子,当删除一个父级资源,所有相关子级资源也一同删除

在 IAuthorRepository 中接口添加方法,在 AuthorMockRepository 中实现类实现接口方法

void DeleteAuthor(AuthorDto author);

public void DeleteAuthor(AuthorDto author)
{
LibraryMockData.Current.Books.RemoveAll(book => book.AuthorId == author.Id);
LibraryMockData.Current.Authors.Remove(author);
}

4.7 更新资源

从 HTTP 方法的角度来看,更新资源有两种情况:

  • 整体更新,PUT 方法完成
  • 部分更新,PATCH 方法完成

整体更新,创建 DTO,在 IBookRepository 中接口添加方法,在 BookMockRepository 中实现类实现接口方法

namespace Library.API.Models
{
public class BookForUpdateDto
{
public string Title { get; set; }
public string Description { get; set; }
public int Pages { get; set; }
}
} void UpdateBook(Guid authorId, Guid bookId, BookForUpdateDto book); public void UpdateBook(Guid authorId, Guid bookId, BookForUpdateDto book)
{
var originalBook = GetBookForAuthor(authorId, bookId); originalBook.Title = book.Title;
originalBook.Pages = book.Pages;
originalBook.Description = book.Description;
}

在 BookController 添加 Action

[HttpPut("{bookId}")]
public IActionResult UpdateBook(Guid authorId, Guid bookId, BookForUpdateDto updateBook)
{
if (!AuthorRepository.IsAuthorExists(authorId))
{
return NotFound();
} var book = BookRepository.GetBookForAuthor(authorId, bookId);
if (book == null)
{
return NotFound();
} BookRepository.UpdateBook(authorId, bookId, updateBook);
return NoContent();
}

部分更新,PATCH 方法的请求正文使用的是 JSON Patch 文档格式

文档由一个数组构成,数组中的每个元素代表一个更改项,每一项包括3项:

  • op:操作类型
  • path:对象的属性名
  • value:对象的值

op 的值包括以下6种:

  • add
  • remove
  • replace
  • copy
  • move
  • test

因此以下内容会更新图书资源的 Title 属性,并清空 Description 属性

[
{
"op": "replace",
"path": "/title",
"value": "Book 1 - Updated"
},
{
"op": "remove",
"path": "/description"
}
]

在 BookController 添加 Action

[HttpPatch("{bookId}")]
public IActionResult PartiallyUpdateBook(Guid authorId, Guid bookId, JsonPatchDocument<BookForUpdateDto> patchDocument)
{
if (!AuthorRepository.IsAuthorExists(authorId))
{
return NotFound();
} var book = BookRepository.GetBookForAuthor(authorId, bookId);
if (book == null)
{
return NotFound();
} var bookToPatch = new BookForUpdateDto
{
Title = book.Title,
Description = book.Description,
Pages = book.Pages
}; patchDocument.ApplyTo(bookToPatch, ModelState);
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
} BookRepository.UpdateBook(authorId, bookId, bookToPatch);
return NoContent();
}

第三个参数类型为 JsonPatchDocument,它的值会从请求信息的正文中获取

ApplyTo 方法将相应的修改操作应用到新建的对象上,并将可能出现的错误记录到 ModelStateDictionary 中,使用该方法需要添加引用

dotnet add package Microsoft.AspNetCore.Mvc.NewtonsoftJson

4.8 内容协商

RESTful API 应该根据客户端的需要返回不同格式的数据

客户端指明格式是在其请求消息的消息头中添加 Accept 项,它的值是一个 MIME 类型,如 application/xml

如果支持返回此格式数据则直接返回,不支持则返回 406 NotAcceptable 状态码

以上过程称为内容协商

ASP.NET Core MVC 中,对于不支持的 Accept 类型返回 406 NotAcceptable 这一配置项默认为 false,因此它会返回默认格式,可以在 ConfigureService 方法中添加 MVC 服务时配置

services.AddMvc(configure =>
{
configure.ReturnHttpNotAcceptable = true;
});

Formatter 是 ASP.NET Core 中用于处理数据输出或输入格式的组件,它分为两类:输出 Formatter 和输入 Formatter

前者满足 HTTP 请求消息头的 Accept 项,后者匹配 HTTP 请求消息头的 Content-Type 项

要使服务器能够返回 XML 格式的数据,只要将能够输出 XML 格式数据的 Formatter 添加到输出 Formatter 集合中即可

services.AddMvc(configure =>
{
configure.ReturnHttpNotAcceptable = true;
configure.OutputFormatters.Add(new XmlSerializerOutputFormatter());
});

services.AddMvc() 方法返回 IMvcBuilder 接口,可以直接调用扩展方法将 XML 格式数据输入输出都添加进来

services.AddMvc(configure =>
{
configure.ReturnHttpNotAcceptable = true;
//configure.OutputFormatters.Add(new XmlSerializerOutputFormatter());
}).AddXmlSerializerFormatters();

对于特殊格式数据,需要创建自定义 Formatter,继承自 TextOutputFormatter 类或 TextInputFormatter 类

本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。

欢迎转载、使用、重新发布,但务必保留文章署名 郑子铭 (包含链接: http://www.cnblogs.com/MingsonZheng/ ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。

如有任何疑问,请与我联系 (MingsonZheng@outlook.com) 。

《ASP.ENT Core 与 RESTful API 开发实战》-- (第4章)-- 读书笔记(下)的更多相关文章

  1. 使用ASP.NET Core构建RESTful API的技术指南

    译者荐语:利用周末的时间,本人拜读了长沙.NET技术社区翻译的技术标准<微软RESTFul API指南>,打算按照步骤写一个完整的教程,后来无意中看到了这篇文章,与我要写的主题有不少相似之 ...

  2. 4类Storage方案(AS开发实战第四章学习笔记)

    4.1 共享参数SharedPreferences SharedPreferences按照key-value对的方式把数据保存在配置文件中,该配置文件符合XML规范,文件路径是/data/data/应 ...

  3. 菜单Menu(AS开发实战第四章学习笔记)

    4.5 菜单Menu Android的菜单主要分两种,一种是选项菜单OptionMenu,通过按菜单键或点击事件触发,另一种是上下文菜单ContextMenu,通过长按事件触发.页面的布局文件放在re ...

  4. [Android]《Android艺术开发探索》第一章读书笔记

    1. 典型情况下生命周期分析 (1)一般情况下,当当前Activity从不可见重新变为可见状态时,onRestart方法就会被调用. (2)当用户打开新的Activity或者切换到桌面的时候,回调如下 ...

  5. 温故知新,使用ASP.NET Core创建Web API,永远第一次

    ASP.NET Core简介 ASP.NET Core是一个跨平台的高性能开源框架,用于生成启用云且连接Internet的新式应用. 使用ASP.NET Core,您可以: 生成Web应用和服务.物联 ...

  6. 快读《ASP.NET Core技术内幕与项目实战》WebApi3.1:WebApi最佳实践

    本节内容,涉及到6.1-6.6(P155-182),以WebApi说明为主.主要NuGet包:无 一.创建WebApi的最佳实践,综合了RPC和Restful两种风格的特点 1 //定义Person类 ...

  7. 零基础ASP.NET Core WebAPI团队协作开发

    零基础ASP.NET Core WebAPI团队协作开发 相信大家对“前后端分离”和“微服务”这两个词应该是耳熟能详了.网上也有很多介绍这方面的文章,写的都很好.我这里提这个是因为接下来我要分享的内容 ...

  8. ASP.NET Core WebApi构建API接口服务实战演练

    一.ASP.NET Core WebApi课程介绍 人生苦短,我用.NET Core!提到Api接口,一般会想到以前用到的WebService和WCF服务,这三个技术都是用来创建服务接口,只不过Web ...

  9. 从 0 使用 SpringBoot MyBatis MySQL Redis Elasticsearch打造企业级 RESTful API 项目实战

    大家好!这是一门付费视频课程.新课优惠价 699 元,折合每小时 9 元左右,需要朋友的联系爱学啊客服 QQ:3469271680:我们每课程是明码标价的,因为如果售价为现在的 2 倍,然后打 5 折 ...

  10. Asp.Net Core 5 REST API - Step by Step

    翻译自 Mohamad Lawand 2021年1月19日的文章 <Asp.Net Core 5 Rest API Step by Step> [1] 在本文中,我们将创建一个简单的 As ...

随机推荐

  1. 区分开发环境和生产环境webpack

  2. d3过滤

    1 <!DOCTYPE html> 2 <html lang="en"> 3 <head> 4 <meta charset="U ...

  3. vue双向定位导航效果

    需求:实现双向定位导航效果,点击左侧菜单,右侧滚动到相应的位置.滚动右边,左侧相应菜单高亮. html代码: 1 <ul class="EntTake_main_left" ...

  4. docker 安装 ElasticSearch 和 Kibana 及ik 中文分词器

    本文为博主原创,未经允许不得转载: 1. 使用 docker 下载 elasticsearch  7.6.1 docker pull elasticsearch:7.6.1 2. 启动 elastic ...

  5. mybatis plus 获取新增实体的主键

    转载请注明出处: mybatis plus 新增实体对象调用的是 IService 接口中的 save 方法: default boolean save(T entity) { return SqlH ...

  6. [SpringMVC] - 解决Jackson中文乱码 : springmvc-servlet.xml

    <!-- 指定响应体返回类型和编码 , 解决乱码????的问题 --> <mvc:annotation-driven> <mvc:message-converters r ...

  7. Go-单元测试-Test

    单元测试 文件名以 _test.go 结尾 函数名以 Test 开头 函数参数固定 t *testing.T 运行单元测试 go test Demo 源文件 package unit import & ...

  8. 2.4G+MCU低功耗二合一芯片SI24R03

    2.4G+MCU低功耗二合一芯片SI24R03 1 简介 Si24R03 是一款高度集成的低功耗 SOC 芯片,其集成了基于 RISC-V 核的低功耗 MCU 和 工作在 2.4GHz ISM 频段的 ...

  9. [转帖]History of Unicode Release and Publication Dates

    www.unicode.org For ease of reference, this page collects together information about the dates for v ...

  10. [转帖]全表扫描却产生大量db file sequential read一例

    老熊 Oracle性能优化 2012-05-23 开发人员在进行新系统上线前的数据校验测试时,发现一条手工执行的SQL执行了超过1小时还没有返回结果.SQL很简单: SELECT * FROM MOB ...