002.WEB API 服务器 RESTful规范

RESTful 是一个撰写风格设计规范,用这个风格写出来的API就叫做RESTful API

没有规范时写一个news用的API可能会像以下

|--------|------|---------------------|
| 功能 | 方法 | 网址 |
| 取得新闻列表 | GET | api/news/getAllList |
| 取得一则新闻 | GET | api/news/getItem/1 |
| 新增一则新闻 | POST | api/news/new |
| 更新一则新闻 | POST | api/news/update |
| 删除一则新闻 | POST | api/news/delete |

另一个人写可能会变成以下这样

|--------|------|--------------------|
| 功能 | 方法 | 网址 |
| 取得新闻列表 | GET | api/news/getList |
| 取得一则新闻 | GET | api/news/getOne/1 |
| 新增一则新闻 | POST | api/news/newOne |
| 更新一则新闻 | POST | api/news/updateOne |
| 删除一则新闻 | POST | api/news/delete/1 |

但采用RESTful API风格开发

|--------|--------|------------|
| 功能 | 方法 | 网址 |
| 取得新闻列表 | GET | api/news |
| 取得一则新闻 | GET | api/news/1 |
| 新增一则新闻 | POST | api/news |
| 更新一则新闻 | PUT | api/news/1 |
| 删除一则新闻 | DELETE | api/news/1 |

简单来讲就是让风格变得一致,且利用不同的Method让网址变得简洁

维护上就会变得清楚,别人也可以更快理解其他人的API接口作用

RESTful API其实并非什么神奇或有特殊功能的东西,它仅仅就是一个写作的风格

以下简单说明各方法(Method)使用情境

GET:取得资料。

POST:新增资料。

PUT:更新资料。

DELETE:删除资料。

以上只是定义,但实际还是会依情况进行适当的调整,出现例外并没有关系。

怕自己风格用的不精准?其实这部分很自由心证,不要太离谱就行,或者同公司有共识即可。


接着,再来介绍一款好用的读取API的软体Postman,这边下载https://www.postman.com/downloads/

承上一个影片提到,浏览器如果要使用GET之外的存取方式比较不适合,甚至下一些参数,所以我们需要另一个软体来做这件事

这边就可以使用Postman来测试我们写好的API

这边带着大家安装一次,首先先到官网下载,下载好就直接执行

接着大家可以打开我的范例档来试一下使用Postman的感觉,按下左上角的+开始读取范例档的API

以下GET取得esp32列表

由于https是需要进行安全验证的,为了方便开发,我们服务器后台统一运行在http模式下,路由也用http进行内网穿透

服务器增删改查请求

下面仅仅演示简单的用法,实际运用在后面章节再优化

1.将服务器控制器类改写如下

cs 复制代码
using Microsoft.AspNetCore.Mvc;

namespace Esp32_Server.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ESP32 : ControllerBase
    {
      
        [HttpGet]
        public IEnumerable<string> Get()
        {
            return new string[] { "HelloWorld1", "HelloWorld2", "HelloWorld3" };
        }

       
        [HttpGet("{id}")]
        public string Get(int id)
        {
            string result = "HelloWorld1";
            if (id == 2)
            {
                result = "HelloWorld2";
            }
            else if (id == 3)
            {
                result = "HelloWorld3";
            }
            return result;
        }

       
        [HttpPost]
        public string Post([FromBody] string value)
        {
            return "Post【" + value + "】";
        }

       
        [HttpPut("{id}")]
        public string Put(int id, [FromBody] string value)
        {
            return "Put【" + value + "】ID:" + id;
        }

      
        [HttpDelete("{id}")]
        public string Delete(int id)
        {
            return "Delete ID:" + id;
        }
    }
}

2.运行测试

0.1常规get得到的数据

0.2get加id得到的数据

0.3POST请求用法

0.4 PUT 修改数据请求

0.5 DELETE(删除)一个ID为4的数据

相关推荐
H.莓飛1 小时前
【C++】【STL】stack_OJ题
服务器·c语言·开发语言·数据结构·c++·算法·visual studio
无足鸟ICT5 小时前
【RHCA+】sosreport(收集诊断文档)
linux·运维·服务器
瑞雪兆丰年兮8 小时前
Linux零基础快速入门-第二章 Linux基础命令
linux·运维·服务器
光电笑映11 小时前
TCP 为什么可靠?从三次握手、滑动窗口到拥塞控制全面拆解(上)
运维·服务器·网络·udp
飞奔的瓜牛11 小时前
Linux 下使用 OpenSSL 生成自签名证书完整指南
运维·服务器·nginx
峥嵘life13 小时前
Android16 热点「网络共享」开关的设计与实现
服务器·网络·microsoft
张小姐的猫14 小时前
【基于 WebSocket 的多用户网页五子棋】—— 整合封装服务器模块设计实现1️⃣
服务器·websocket·网络协议
心之王者7161 天前
Linux 进程信号:从产生、阻塞到捕捉与子进程回收
linux·服务器·网络
manageengine1 天前
服务器 CPU 100% 怎么排查:8 条命令从现象定位到根因
运维·服务器·cpu
赤生云电竞1 天前
云游戏边缘节点部署:机房选址与网络拓扑优化实践 —— 从80ms时延预算看节点落位与Spine-Leaf组网
服务器·游戏·spine