创建基于OData的Web API - Knowledge Builder API, Part IV: Write Controller
基于上一篇《创建基于OData的Web API - Knowledge Builder API, Part III:Write Model and Controller》,新创建的OData Service已经能够正常显示metadata和读所有记录了,但是最基本的创建,读取单个,修改单个功能还没有。
本篇就在上一篇的基础上,增强Controller使之能涵盖CRUD的全部功能。
1. 对于Create操作,通常映射到POST方法,在KnowledgesController中加入如下方法
// POST: /Knowledges
/// <summary>
/// Support for creating knowledge
/// </summary>
public async Task<IActionResult> Post([FromBody] Knowledge knowledge)
{
if (!ModelState.IsValid)
{
foreach (var value in ModelState.Values)
{
foreach(var err in value.Errors)
{
System.Diagnostics.Debug.WriteLine(err.Exception?.Message);
}
} return BadRequest();
} _context.Knowledges.Add(knowledge);
await _context.SaveChangesAsync(); return Created(knowledge);
}
注意,因为创建Knowledge必须保证数据的完整性(Model中使用Annotation),所以这里需要判断ModelState。
在Debug语境下,程序会输出所有错误信息。
2. 对于Update操作,对应于PUT方法,则加入如下方法,
// PUT: /Knowledges/5
/// <summary>
/// Support for updating Knowledges
/// </summary>
public async Task<IActionResult> Put([FromODataUri] int key, [FromBody] Knowledge update)
{
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
} if (key != update.ID)
{
return BadRequest();
} _context.Entry(update).State = EntityState.Modified;
try
{
await _context.SaveChangesAsync();
}
catch (DbUpdateConcurrencyException)
{
if (!_context.Knowledges.Any(p => p.ID == key))
{
return NotFound();
}
else
{
throw;
}
} return Updated(update);
}
这里省略了与Create操作中一样的错误输出信息。
3. 对于Delete操作,对应于DELETE方法,则加入:
// DELETE: /Knowledges/5
/// <summary>
/// Support for deleting knowledge by key.
/// </summary>
public async Task<IActionResult> Delete([FromODataUri] int key)
{
var knowledge = await _context.Knowledges.FindAsync(key);
if (knowledge == null)
{
return NotFound();
} _context.Knowledges.Remove(knowledge);
await _context.SaveChangesAsync(); return StatusCode(); // HttpStatusCode.NoContent
}
4. 另外一种Update方法,即HTTP PATCH,
// PATCH: /Knowleges
/// <summary>
/// Support for partial updates of knowledges
/// </summary>
public async Task<IActionResult> Patch([FromODataUri] int key, [FromBody] Delta<Knowledge> knowledge)
{
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
} var entity = await _context.Knowledges.FindAsync(key);
if (entity == null)
{
return NotFound();
} knowledge.Patch(entity); try
{
await _context.SaveChangesAsync();
}
catch (DbUpdateConcurrencyException)
{
if (!_context.Knowledges.Any(p => p.ID == key))
{
return NotFound();
}
else
{
throw;
}
} return Updated(entity);
}
5. 单个读,同样对应于HTTP GET操作,不同的是,它需要指定Key。
/// GET: /Knowledges(:id)
/// <summary>
/// Adds support for getting a knowledge by key, for example:
///
/// GET /Knowledges(1)
/// </summary>
/// <param name="key">The key of the Knowledge required</param>
/// <returns>The Knowledge</returns>
[EnableQuery]
public SingleResult<Knowledge> Get([FromODataUri] int key)
{
return SingleResult.Create(_context.Knowledges.Where(p => p.ID == key));
}
6. 至此,这个Controller已经支持了CRUD操作,可以打开Postman等操作进行测试了。
同时,可以参阅OData官方文档关于Query Data的方法,使用OData强大的数据检索功能进行读取测试。
是为之记。
Alva Chien
2019.11.19
创建基于OData的Web API - Knowledge Builder API, Part IV: Write Controller的更多相关文章
- 创建基于OData的Web API - Knowledge Builder API, Part I:Business Scenario
在.NET Core 刚刚1.0 RC的时候,我就给OData团队创建过Issue让他们支持ASP.NET Core,然而没有任何有意义的答复. Roadmap for ASP.NET Core 1. ...
- 创建基于OData的Web API - Knowledge Builder API, Part III:Write Model
在前两篇文章<Part I: Business Scenario> 和<Part II: Project Setup>后,可以开始真正Model的创建. 步骤如下: 1. 创建 ...
- 创建基于OData的Web API - Knowledge Builder API, Part II:Project Setup
本篇为Part II:Project Setup 查看第一篇<Part I: Business Scenario> 第一步,准备步骤. 准备步骤一,下载.NET Core 2.2 SDK ...
- 使用 node-odata 轻松创建基于 OData 协议的 RESTful API
前言 OData, 相信身为.NET程序员应该不为陌生, 对于他的实现, 之前也有童鞋进行过介绍(见:这里1,这里2). 微软的WCF Data Service即采用的该协议来进行通信, ASP.NE ...
- 基于SVG的web页面图形绘制API介绍
转自:http://blog.csdn.net/jia20003/article/details/9185449 一:什么是SVG SVG是1999由W3C发布的2D图形描述语言,纯基于XML格式的标 ...
- Java Web学习系列——创建基于Maven的Web项目
创建Maven Web项目 在MyEclipse for Spring中新建Maven项目 选择项目类型,在Artifact Id中选择maven-archetype-webapp 输入Group I ...
- 可能是最简单的方式:利用Eclipse创建基于Maven的Web项目
1. 新建一个maven项目 2.在弹出框中选择创建一个简单项目 3. 然后输入参数,需要注意的是,在packagin中,选择war,web项目应该选择war 4. 点击finish后,基本项目结构就 ...
- idea创建基于maven的web项目
1.点击create new project,选择maven,点击next 2.输入项目信息,点击finish 3.进入项目后,点击菜单File->Project Structure开始配置项目 ...
- maven-bundle-plugin插件, 用maven构建基于osgi的web应用
maven-bundle-plugin 2.4.0以下版本导出META-INF中的内容到MANIFEST.MF中 今天终于把maven-bundle-plugin不能导出META-INF中的内容到Ex ...
随机推荐
- Redis 哨兵机制以及灾难演练
#### 哨兵都采用这个配置即可 ##### 1.修改sentinel.conf配置文件 ![image](https://img2018.cnblogs.com/blog/1334966/20191 ...
- python学习-函数和lambda表达式(五)
5.2函数参数 位置参数:根据位置传入参数 关键字参数:根据参数名来传入参数 def girth(width, height): print("width:", width) pr ...
- HDFS概述(一)
HDFS概述(一) 1. HDFS产出的背景及定义 1.1 HDFS产生的背景 随着数据量越来越大,在一个操作系统存不下所有的数据,那么就分配到更多的操作系统管理的磁盘中,但是不方便管理和维护,迫切需 ...
- 15.Linux软件管理
1.什么是rpm? rpm软件包的组成部分有哪些? redhat packages manager 红帽推出软件包管理工具... rpm工具 xxxxx.rpm bash-4.2.46-28.el7. ...
- SpringBoot中如何灵活的实现接口数据的加解密功能?
数据是企业的第四张名片,企业级开发中少不了数据的加密传输,所以本文介绍下SpringBoot中接口数据加密.解密的方式. 本文目录 一.加密方案介绍二.实现原理三.实战四.测试五.踩到的坑 一.加密方 ...
- 简单多层神经网络实现异或XOR
最近在看<Neural Network Design_Hagan> 然后想自己实现一个XOR 的网络. 由于单层神经网络不能将异或的判定分为两类. 根据 a^b=(a&~b)|(~ ...
- Leetcode Tags(4)Stack & Queue
一.232. Implement Queue using Stacks private Stack<Integer> stack; /** Initialize your data str ...
- Flask解析(一):Local、LocalStak、LocalProxy
原创作者:flowell,转载请标明出处:https://www.cnblogs.com/flowell/p/local_local_proxy_local_stack.html Local是什么? ...
- css简介以及css的添加方法
什么是css? CSS是Cascading Style Sheets的简称,CSS是用来美化网页中文称为层叠样式表,用来控制网页数据的表现,可以使网页的表现与数据内容分离. css的基本语法 1.选择 ...
- postman的监控接口响应时间monitor
Monitor简介1.是基于Postman集合API的灵活监控 2.监控API的正常运行时间.响应能力和正确性 3.提供监测结果的详细报告 4.对所有Postman用户每月提供1000个免费的监控请求 ...