基于Visual studio创建API项目

API(英文全称:Application Programming Interface,中文:应用程序编程接口)
为什么要
通过API接口可以与其他软件实现数据相互通信,API这项技术能够提高开发效率。

本文是基于vs2017 .net平台搭建API。希望可以帮助到学习.net API开发的朋友们。

本文创建的API与RESTful API 是类似的。

→→→→→多了不说,少了不唠。进入正题→→→→

创建API项目

文件–新建–项目 打开【添加新项目】窗口,然后选择【ASP.NET Web应用程序(.NET Framework)】,点击确定,如下所示:
在这里插入图片描述
选择空项目,添加文件夹和核心引用:选中【Web API】,点击确定
在这里插入图片描述
创建API完成,目录如下:
在这里插入图片描述
Models、views和Controllers存放三层架构内容(views文件夹在添加文件夹和核心引用时没有选择MVC选项,所以没有创建)
App_Start中WebApiConfig.cs是存放API路由配置的文件

现在创建API 类文件,在Controllers文件夹右键,新建API控制类,创建UserController类。如图:
在这里插入图片描述
继承ApiController,如图:
在这里插入图片描述

讲解:继承ApiController后会实现 四种请求方式 (GET, PUT, POST, DELETE), 按照下列方式映射为 CURD(数据库的增删改查) 操作:

1、POST 用于在服务端新建资源,在指定的URL上创建一个新的对象,将新资源的地址作为响应消息返回;
2、PUT 利用URL 请求用于更新服务端的资源,如果服务端允许,PUT 也可以用于新建一个资源;
3、GET 通过 URL获取服务端资源,进行资源返回
4、DELETE 利用URL删除指定的资源。

做个小例子

在Model中创建一个User类

namespace APITool.Models
{public class User{public int Id { get; set; }public string Password { get; set; }public string UserName { get; set; }public string NickName { get; set; }public DateTime LoginTime { get; set; }}
}

连接数据库,由于代码量较多文章分两部分写(DataHelper类请点击这里)

  • SQL Server数据库连接信息:
<connectionStrings><add name="APITool.Properties.Settings.SqlServerConnection" connectionString="Data Source=localhsot;Initial Catalog=test;Persist Security Info=True;User ID=sa;Password=sa"providerName="System.Data.SqlClient" /></connectionStrings>
  • Mysql数据库连接信息:
<connectionStrings><add name="APITool.Properties.Settings.MySqlConnection" connectionString="server=localhost;user=root;password=password;database=mydatabase"providerName="MySql.Data.MySqlClient" /></connectionStrings>
  1. GET方式

c#代码

SqlHelper sqlHelper = new SqlHelper();// GET api/<controller>
public IHttpActionResult Get()
{DataHelper dataHelper = new DataHelper();//数据库操作类DataSet dataSet =  dataHelper.GetDataSet(sqlHelper.USERSQL);//连接数据库并返回dataset集合List<User> userList = new List<User>();//处理集合数据并返回foreach (DataRow row in dataSet.Tables[0].Rows){User user = new User();foreach (var prop in user.GetType().GetProperties()){if (!row.IsNull(prop.Name)){prop.SetValue(user, row[prop.Name], null);}}userList.Add(user);}return Ok(userList);
}

postmain请求:
![在这里插入图片描述](https://img-blog.csdnimg.cn/82639fdafe5746f988442734c4a62d1f.png

  1. 带参数Get请求

c#代码

// GET api/<controller>/5 或者api/<controller>?Id=1public List<User> Get(int id){List < User > userList = new List<User>();DataHelper dataHelper = new DataHelper();//数据库操作类//sql参数DbParameter[] dbParameters = {new SqlParameter("Id",SqlDbType.Int){Value = id}};//连接数据库并返回DataTable 集合DataTable dataTable = dataHelper.GetDataSet(sqlHelper.USERWHERESQL, dbParameters);//处理集合数据并返回foreach (DataRow row in dataTable.Rows){User user = new User();foreach (var prop in user.GetType().GetProperties()){if (!row.IsNull(prop.Name)){prop.SetValue(user, row[prop.Name], null);}}userList.Add(user);}return userList;}
  • postmain请求①: localhost:51361/api/User?Id=2

在这里插入图片描述

  • postmain请求②: localhost:51361/api/User/2

在这里插入图片描述

3、POST请求

c#代码

// POST api/<controller>public IHttpActionResult Post([FromBody]List<User> user){string result = "SUCCESS";DataHelper dataHelper = new DataHelper();for (int i = 0; i < user.Count; i++){try{DbParameter[] dbParameters = {new SqlParameter("@UserName", SqlDbType.Text) { Value = user[i].UserName },new SqlParameter("@Password", SqlDbType.Text) { Value = user[i].Password },new SqlParameter("@NickName", SqlDbType.Text) { Value = user[i].NickName },new SqlParameter("@LoginTime", SqlDbType.DateTime) { Value = user[i].LoginTime },};dataHelper.ExecuteSql(sqlHelper.INSERT_USER_ID_SQL, dbParameters);}catch{result = "fail";}}return Ok(result);}

json请求参函数

[{"Password":"123456","UserName":"T11","NickName":"T11","LoginTime":"2023-08-25 00:00:00"},{"Password":"123456","UserName":"T12","NickName":"T12","LoginTime":"2023-08-25 00:00:00"}
]
  • postman请求

在这里插入图片描述
数据库信息:
在这里插入图片描述
4、DELETE请求

c#代码

// DELETE api/<controller>/5
public IHttpActionResult Delete(int id)
{List<User> userList = new List<User>();DataHelper dataHelper = new DataHelper();DbParameter[] dbParameters = {new SqlParameter("Id",SqlDbType.Int){Value = id}};int count = dataHelper.ExecuteSql(sqlHelper.DELETE_USER_ID_SQL, dbParameters);return Ok(count);
}
  • postman请求

在这里插入图片描述
数据库信息:
在这里插入图片描述




补充:

请求数据格式区别:
GET方式,一般采用URL的方式进行传递参数
POST,PUT,DELETE方式,采用body传参,格式一般是JSON。

API请求结果返回码:
200 OK 请求成功

201 Created 请求成功并创建资源

400 Bad Request 请求参数有错误

401 Unauthorized 权限出现问题

403 Forbidden 表示身份认证通过了,但是对服务器请求资源的访问被拒绝

404 Not Found 表示服务器找不到请求的资源

500 Internal Server Error 表示服务器出现错误,极大可能是出现bug

503 Service Unavailable 表示服务器超负载或正停机维护,无法处理请求









以上 end

大鹏一日通风起 扶摇直上九万里*

诸位加油

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/109882.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

法律小程序开发:让法律咨询更便捷

在现代社会&#xff0c;法律咨询服务越来越受到人们的重视和需求。为了方便用户预约法律咨询&#xff0c;很多律所都开始使用小程序来提供在线预约服务。那么&#xff0c;如何制作一款律所预约小程序呢&#xff1f; 首先&#xff0c;我们可以选择乔拓云网作为制作小程序的平台。…

鸿蒙是一个怎么样的操作系统,真的是安卓套壳吗?

从鸿蒙项目正式推出以来&#xff0c;就一直有各自声音&#xff0c;有看好的&#xff0c;认为鸿蒙的出现将会成为一个智能终端设备操作系统的框架和平台&#xff0c;促进万物互联产业的繁荣发展&#xff1b;也有的人在唱衰&#xff0c;觉得鸿蒙发展不起来&#xff0c;甚至认为鸿…

LLM预训练大型语言模型Pre-training large language models

在上一个视频中&#xff0c;您被介绍到了生成性AI项目的生命周期。 如您所见&#xff0c;在您开始启动您的生成性AI应用的有趣部分之前&#xff0c;有几个步骤需要完成。一旦您确定了您的用例范围&#xff0c;并确定了您需要LLM在您的应用程序中的工作方式&#xff0c;您的下…

设计模式第九讲:常见重构技巧 - 去除不必要的!=

设计模式第九讲&#xff1a;常见重构技巧 - 去除不必要的! 项目中会存在大量判空代码&#xff0c;多么丑陋繁冗&#xff01;如何避免这种情况&#xff1f;我们是否滥用了判空呢&#xff1f;本文是设计模式第九讲&#xff0c;讲解常见重构技巧&#xff1a;去除不必要的! 文章目录…

关于disriminative 和 generative这两种模型

但是&#xff0c;其实&#xff0c;根据李宏毅老师讲到的&#xff0c;generative model是做了一些假设的&#xff0c;比如&#xff0c;如果使用Naive Bayes的话&#xff0c;不同特征x1,x2...之间相互独立的话&#xff0c;其实是很容易出现较大的偏差的&#xff0c;因为不同特征变…

持续集成与持续交付:现代软件测试的变革之路

引言 在数字化时代&#xff0c;软件开发的速度和复杂性都在不断增加。为了满足市场的需求&#xff0c;企业需要更快、更高效地交付高质量的软件产品。在这样的背景下&#xff0c;持续集成与持续交付&#xff08;CI/CD&#xff09;成为了软件开发和测试的核心实践。 软件开发的…

微信小程序 基于Android的美容理发师预约管理系统

&#xff0c;本系统主要根据管理员、用户及理发师的实际需要&#xff0c;方便用户利用互联网实现对商品信息进行立即订购&#xff0c;同时让管理者可以通过这个系统对用户实际需求以及各信息进行管理。设计该系统主要目的是为了方便用户、理发师可以有一个非常好的平台体验&…

美团面试拷打:ConcurrentHashMap 为何不能插入 null?HashMap 为何可以?

周末的时候,有一位小伙伴提了一些关于 ConcurrentHashMap 的问题,都是他最近面试遇到的。原提问如下(星球原贴地址:https://t.zsxq.com/11jcuezQs ): 整个提问看着非常复杂,其实归纳来说就是两个问题: ConcurrentHashMap 为什么 key 和 value 不能为 null?ConcurrentH…

LeetCode面试经典150题(day 1)

LeetCode是一个免费刷题的一个网站&#xff0c;想要通过笔试的小伙伴可以每天坚持刷两道算法题。 接下来&#xff0c;每天我将更新LeetCode面试经典150题的其中两道算法题&#xff0c;一边巩固自己&#xff0c;一遍希望能帮助到有需要的小伙伴。 88.合并两个有序数组 给你两个…

Java接收json参数

JSON 并不是唯一能够实现在互联网中传输数据的方式&#xff0c;除此之外还有一种 XML 格式。JSON 和 XML 能够执行许多相同的任务&#xff0c;那么我们为什么要使用 JSON&#xff0c;而不是 XML 呢&#xff1f; 之所以使用 JSON&#xff0c;最主要的原因是 JavaScript。众所周知…

单例模式的相关知识

饿汉模式 package Thread; class Singleton{private static Singleton instance new Singleton();public static Singleton getInstance(){return instance;}private Singleton(){} }public class demo1 {public static void main(String[] args) {Singleton S1 Singleton.ge…

什么是字体图标(Icon Font)?如何在网页中使用字体图标?

聚沙成塔每天进步一点点 ⭐ 专栏简介⭐ 字体图标&#xff08;Icon Font&#xff09;⭐ 如何在网页中使用字体图标⭐ 写在最后 ⭐ 专栏简介 前端入门之旅&#xff1a;探索Web开发的奇妙世界 记得点击上方或者右侧链接订阅本专栏哦 几何带你启航前端之旅 欢迎来到前端入门之旅&a…

时空数据挖掘精选23篇论文解析【AAAI 2023】

今天和大家分享时空数据挖掘方向的资料。 时空数据挖掘是人工智能技术的重要分支&#xff0c;是一种采用人工智能和大数据技术对城市时空数据进行分析与挖掘的方法&#xff0c;旨在挖掘时空数据&#xff0c;理解城市本质&#xff0c;解决城市问题。 目前&#xff0c;时空数据…

windows下Mysql安装配置教程

Mysql下载 在官网下载mysql community Server https://dev.mysql.com/downloads/mysql/ 可以选择下载压缩包或者MSI安装程序 使用压缩包安装 MySQL 压缩包安装通常需要以下步骤&#xff1a; 1. 下载 MySQL 安装包 你可以从 MySQL 官网上下载适合你系统的 MySQL 安装包&am…

裸露土堆识别算法

裸露土堆识别算法首先利用图像处理技术&#xff0c;提取出图像中的土堆区域。裸露土堆识别算法首通过计算土堆中被绿色防尘网覆盖的比例&#xff0c;判断土堆是否裸露。若超过40%的土堆没有被绿色防尘网覆盖&#xff0c;则视为裸露土堆。当我们谈起计算机视觉时&#xff0c;首先…

StableVideo:使用Stable Diffusion生成连续无闪烁的视频

使用Stable Diffusion生成视频一直是人们的研究目标&#xff0c;但是我们遇到的最大问题是视频帧和帧之间的闪烁&#xff0c;但是最新的论文则着力解决这个问题。 本文总结了Chai等人的论文《StableVideo: Text-driven consistency -aware Diffusion Video Editing》&#xff…

民族传统文化分享系统uniapp 微信小程序

管理员、用户可通过Android系统手机打开系统&#xff0c;注册登录后可进行管理员后端&#xff1b;首页、个人中心、用户管理、知识分类管理、知识资源管理、用户分享管理、意见反馈、系统管理&#xff0c;用户前端&#xff1b;首页、知识资源、用户分享、我的等。 本系统的使用…

DiskCatalogMaker for Mac简单智能快速的磁盘管理工具

DiskCatalogMaker是一款Mac上的磁盘目录管理工具。它可以帮助用户快速创建和管理磁盘目录&#xff0c;方便查找和访问存储在磁盘上的文件和文件夹。它具有快速扫描和索引功能&#xff0c;生成详细的目录列表&#xff0c;支持关键字搜索和自定义标签。 此外&#xff0c;DiskCat…

Go 切片

切片 一、切片&#xff08;slice&#xff09;概念 在讲解切片&#xff08;slice&#xff09;之前&#xff0c;大家思考一下数组有什么问题&#xff1f; 数组定义完&#xff0c;长度是固定的。例如&#xff1a; var num [5]int [5]int{1,2,3,4,5}定义的num数组长度是5&#…

taro react/vue h5 中的上传input onchange 值得区别

<inputclassNamebase-input-file-h5typefileacceptimage/*capturecameraonChange{onChangeInput} />1、taro3react 2、taro3vue3