.net core api +swagger(一个简单的入门demo 使用codefirst+mysql)
前言:
自从.net core问世之后,就一直想了解。但是由于比较懒惰只是断断续续了解一点。近段时间工作不是太忙碌,所以偷闲写下自己学习过程。慢慢了解.net core 等这些基础方面学会之后再用.net core写一个项目,前期文章都是为之后的项目做准备。同时也希望这些基础文章能帮助更多的想入手 .net core的小白。(文中如有不正确地方欢迎各位指正)
开发工具vs2017
数据库 mysql8.0
.net core环境 .net core2.1
1】model层建立
先新建一个项目:左侧目录选择其他项目类型=》vs解决方案=》空白方案=》自己随意去个名字
添加一个core 内库作为model层,
由于本次数据库使用的是mysql,所以在model层中通过nuget分别引用Microsoft.EntityFrameworkCore.Tools和Pomelo.EntityFrameworkCore.MySql(注意两个版本必须一致 这里选自2.1.4版本,之前博主引用版本不对,直接导致连接输出出错)
然后分别添加一个model类和数据库上下文类,本demo创建一张user表
数据库上下文类DataBase
using Microsoft.EntityFrameworkCore; namespace Core.Model
{
public class DataBase : DbContext
{
//构造方法
public DataBase(DbContextOptions<DataBase> options)
: base(options)
{ } #region 数据区域
public DbSet<User> User { get; set; }
#endregion }
}
至此,model创建完毕,后期各位可以根据自己的需要自己拓展
2】创建api层
首先在解决方案中创建api层,流程如下图
建议新手选择api这一项,创建完毕之后,项目结构如右图
别忘记在api层添加对model层的引用
首先来appsettings.json配置数据库,127.0.0.1代表本地计算机
配置完毕之后来到 Startup.cs的ConfigureServices方法将数据库连接配置好,如果此段代码有飘红部分,只需要将其缺失的地方引用(需要引用
using Microsoft.EntityFrameworkCore;和using Core.Model;)
//mysql连接
services.AddDbContextPool<DataBase>(options =>
options.UseMySql(Configuration.GetConnectionString("MySqlConnection")));
注意括号中的MySqlConnection就是appsettings.json中写连接数据库字符串的前缀
接下来将原有的控制器删除,自己添加一个UserController.cs
控制器中代码(包含增删查改CRUD)
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Core.Model;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc; namespace Core.api.Controllers
{
[Produces("application/json")]
[Route("api/admin/[controller]")]
[ApiController]
public class UserController : Controller
{ private readonly DataBase _context;
public UserController(DataBase context)
{
_context = context;
}
#region base /// <summary>
/// 获取单个
/// </summary>
/// <param name="id">Id</param>
/// <returns></returns>
[HttpGet("{id}")]
public JsonResult GetById(string id)
{
var tt = _context.Set<User>().Where(c => c.id == id).ToList();
//_context.Set<User>().Add(us);
//_context.SaveChanges();
return Json(tt);
}
/// <summary>
/// 添加
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
[HttpPost]
public JsonResult Add(User entity = null)
{
_context.Set<User>().Add(entity);
int num = _context.SaveChanges(); if (entity == null)
return Json("参数为空");
if (num > ) { return Json("成功"); }
else { return Json("失敗"); }
}
/// <summary>
/// 编辑
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
[HttpPut]
[Route("User")]
public JsonResult Update(User entity = null)
{ _context.Set<User>().Update(entity);
int num = _context.SaveChanges();
if (entity == null)
return Json("参数为空");
if (num > ) { return Json("成功"); }
else { return Json("失敗"); }
} /// <summary>
/// 删除
/// </summary>
/// <param name="ids"></param>
/// <returns></returns>
[HttpDelete]
public JsonResult Dels(string ids = null)
{
if (ids.Length == )
return Json("参数为空");
var tt = _context.Set<User>().Where(c => c.id == ids).First();
_context.Set<User>().Remove(tt);
int num = _context.SaveChanges();
if (num > ) { return Json("成功"); }
else { return Json("失敗"); }
}
#endregion
}
}
自此一个简单的api基本完成,需要运行检验还需要一个步骤。
3】swagger
为了检测接口运行,这里选择swagger
首先在api层通过nuget引用Swashbuckle.AspNetCore
然后右键单击core.api项目选择属性,打开一个新面板之后选择左侧的生成菜单=》扎到输出提示。选择输出路径bin\Debug\netcoreapp2.1\=》勾选xml文档文件
然后回到 Startup.cs ,分别加入以下代码
此处需要先在nuget中引用 Microsoft.Extensions.PlatformAbstractions
注意 上文中生成的core.api.xml写入到下列方法中 ,名字要保持一致,否者报错
#region Swagger
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info
{
Version = "v1.1.0",
Title = "Ray WebAPI",
Description = "框架集合",
TermsOfService = "None",
Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "RayWang", Email = "2271272653@qq.com", Url = "http://www.cnblogs.com/RayWang" }
});
//添加读取注释服务 nuget Microsoft.Extensions.PlatformAbstractions
var basePath = PlatformServices.Default.Application.ApplicationBasePath;
var xmlPath = Path.Combine(basePath, "Core.api.xml");//此处为生成xml文档
c.IncludeXmlComments(xmlPath); });
#endregion
#region Swagger
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
});
#endregion
,最后来到launchSettings.json修改以下代码,将api/value修改为swagger,表示项目已启动就显示Swagger的主页面,而不用通过输入路劲
因为本项目是codefirst,所以最后在项目启动之前别忘记在nuget控制台运行以下两行代码
先输入:Add-Migration MyFirstMigration(名字。这里随意取未MyFirstMigration)
在输入:Update-Database 补充一个小问题,博主首次在nuget控制台输入
Add-Migration MyFirstMigration的时候不知道为什么报错,后来先输入Add-Migration 然后随意取一个名字才成功。之前未遇见过。如果遇到此类错误的读者可以先试试我这个办法。
最后】最后运行代码,就会看到页面如下
添加一条数据进行尝试,单击绿色post=》单击try it out =》输入数据(这里我全部输入“测试”)=》单击execute
然后鼠标下滑,就可以看到返回的结果
然后进入数据库验证,发现数据插入成功
.net core api +swagger(一个简单的入门demo 使用codefirst+mysql)的更多相关文章
- C#中缓存的使用 ajax请求基于restFul的WebApi(post、get、delete、put) 让 .NET 更方便的导入导出 Excel .net core api +swagger(一个简单的入门demo 使用codefirst+mysql) C# 位运算详解 c# 交错数组 c# 数组协变 C# 添加Excel表单控件(Form Controls) C#串口通信程序
C#中缓存的使用 缓存的概念及优缺点在这里就不多做介绍,主要介绍一下使用的方法. 1.在ASP.NET中页面缓存的使用方法简单,只需要在aspx页的顶部加上一句声明即可: <%@ Outp ...
- .Net Core 跨平台:一个简单程序的多平台(windows、Linux、osx)发布
.Net Core 跨平台:一个简单程序的多平台(windows.Linux.osx)发布 .Net Core 3.0 已于2019年9月23日发布了,包含了一些新特性,具体参见Announcing ...
- Maven+SpringMVC+Dubbo 简单的入门demo配置
转载自:https://cloud.tencent.com/developer/article/1010636 之前一直听说dubbo,是一个很厉害的分布式服务框架,而且巴巴将其开源,这对于咱们广大程 ...
- ASP.NET CORE API Swagger+IdentityServer4授权验证
简介 本来不想写这篇博文,但在网上找到的文章博客都没有完整配置信息,所以这里记录下. 不了解IdentityServer4的可以看看我之前写的入门博文 Swagger 官方演示地址 源码地址 配置Id ...
- IdentityServer4实现.Net Core API接口权限认证(快速入门)
什么是IdentityServer4 官方解释:IdentityServer4是基于ASP.NET Core实现的认证和授权框架,是对OpenID Connect和OAuth 2.0协议的实现. 通俗 ...
- 通过Knockout.js + ASP.NET Web API构建一个简单的CRUD应用
REFERENCE FROM : http://www.cnblogs.com/artech/archive/2012/07/04/Knockout-web-api.html 较之面向最终消费者的网站 ...
- asp .net core中swagger的简单使用
相信swagger大家不太陌生,简单来说就是把web api接口以ui的形式呈现到页面上,供方便调用和展示.这边文章就带大家初步简单使用swagger. (1)首先需要安装包:Swashbuckle. ...
- spring boot一个简单用户管理DEMO
概述 该Demo旨在部署一个简单spring boot工程,包含数据编辑和查看功能 POM配置 <?xml version="1.0" encoding="UTF- ...
- 实现一个简单的虚拟demo算法
假如现在你需要写一个像下面一样的表格的应用程序,这个表格可以根据不同的字段进行升序或者降序的展示. 这个应用程序看起来很简单,你可以想出好几种不同的方式来写.最容易想到的可能是,在你的 JavaScr ...
随机推荐
- Django运算表达式与Q对象/F对象
Django运算表达式与Q对象/F对象 1 模型查询 概述: 1 查询集:表示从数据库中获取的对象的集合 2 查询集可以有多个过滤器,通过 逻辑运算符连接 3 过滤器就是一个函数,基于所给的参数限制查 ...
- Django 基础二(View和urls)
上一篇博文已经成功安装了python环境和Django,并且新建了一个空的项目.接下来就可以正式开始进行Django下 的Web开发了.首先进入项目的主目录: cd ./DjangoLearn/hol ...
- Python+Appium 查找 toast 方法的封装
使用场景:在操作应用时常见toast弹框,通过toast弹框信息的获取判断当前的某个操作是否成功 引用的包:from selenium.webdriver.support import expecte ...
- eclipse中去掉py文件中烦人的黄色弹框
eclipse中写py文件,当鼠标点击在参数上时总是出现黄线的弹框,影响人操作,感觉特别烦,如下: 解决方案: windows--preferences--hover--pydev--hover取消选 ...
- css中固定宽高div与不固定宽高div垂直居中的处理办法
固定高宽div垂直居中 如上图,固定高宽的很简单,写法如下: position: absolute; left: 50%; top: 50%; width:200px; height:100px; m ...
- 华为手机无法使用USB调试的解决方案
在Android开发中,一直在使用华为的荣耀8进行调试,但是突然某一次,发现USB调试无法使用了,且在其他的电脑上进行调试也不行. 后来经过查资料,总算解决了此问题,在这里进行一下解决方案的记录. 需 ...
- C#串口通讯概念以及简单实现
最近在研究串口通讯,其中有几个比较重要的概念,RS-232这种适配于上位机和PC端进行连接,RS-232只限于PC串口和设备间点对点的通信.它很简单的就可以进行连接,由于串口通讯是异步的,也就是说你可 ...
- 『性能』测试一下 MSSqlHelper 的性能
本文没啥技术含量,就是测试一下 MSSqlHelper 在 使用反射.不使用反射 的性能对比. 之后,不要问为什么不用 ORM 这类的东西 —— 会有另外的文章 介绍 自己这些年 自己的ORM 升级历 ...
- Dubbo Mesh 在闲鱼生产环境中的落地实践
本文作者至简曾在 2018 QCon 上海站以<Service Mesh 的本质.价值和应用探索>为题做了一次分享,其中谈到了 Dubbo Mesh 的整体发展思路是“借力开源.反哺开源” ...
- Odoo 12 开发手册指南(八)—— 业务逻辑 – 业务流程的支持
在前面的文章中,我们学习了模型层.如何创建应用数据结构以及如何使用 ORM API 来存储查看数据.本文中我们将利用前面所学的模型和记录集知识实现应用中常用的业务逻辑模式. 本文的主要内容有: 以文件 ...