系列目录:

【Docker】 CentOS7 安装 Docker 及其使用方法 ( 一 )

【Docker】 使用Docker 在阿里云 Centos7 部署 MySQL 和 Redis (二)

【Docker】 .Net Core 3.1 webapi 集成EF Code First,使用MySql进行业务操作 、配置swagger (三)

.......持续不定期更新中

之前一直用.Net Core 2.1 ,发现3.1后有很多地方和原来的操作不同,踩了一些坑,所以记录一下3.1的操作方法

1.开发环境

.Net Core 3.1

MySql : 5.7.32

2.创建webapi项目

3.查看项目结构,新建ValuesController ,运行项目,打开浏览器访问项目地址 XXX/api/Values

    [Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
[HttpGet]
public string Get()
{
return "value";
}
}

4.集成EntityFramework,打开Nuget,安装EntityFramework的包 

下载如下包:

Pomelo.EntityFrameworkCore.MySql      此包用于集成EF,进行增删改查等操作

Microsoft.EntityFrameworkCore.Tools     此包是EF工具包,没有不可以使用数据迁移更新数据库

P.S : MySql.Data.XXX   等Mysql官方包不可用 最新版8.0.22 目前不支持.Net Core 3.1,安装后不可用 。

appsetting.json文件添加数据库连接

"ConnectionStrings": {
"conn": "Data Source=localhost;Database=test;User ID=root;Password=sima1234;port=3306;sslmode=none;"
},

添加数据库DbContext类

public class MyDbContext : DbContext
{
public MyDbContext(DbContextOptions<MyDbContext> options) : base(options)
{
}
public DbSet<User> users { get; set; }
}

打开startup.cs,把db对象注入一下,方便Controller层使用,再改造一下Controller,把路径改成自定义。

services.AddScoped<DbContext, MyDbContext>();   //注入一下db对象
services.AddDbContext<MyDbContext>(options => options.UseMySql(Configuration.GetConnectionString("conn")));

5.打开程序包管理控制台,使用Code First创建数据库

add-Migration init    \\ init是名字 随便自己取名字  如果有错可以用 Remove-Migration 回退
update-database \\ 上一步成功后更新数据库

生成的Migration迁移文件

打开数据库查看,user成功创建,另外那张表是ef数据迁移版本记录表

6.修改Controller层代码,自定义访问路径

    [Route("/[controller]/[action]")]
[ApiController]
public class ValuesController : ControllerBase
{
private DbContext _db;
public ValuesController(MyDbContext db)
{
this._db = db;
} [HttpGet]
public async Task<string> Add()
{
User user = new User();
user.Username = "admin";
user.Password = "123456";
await _db.Set<User>().AddAsync(user);
await _db.SaveChangesAsync();
return "value";
}
}

运行结果,注意!访问地址已经为自己定义的了。

7 配置swagger

配置swagger 用于自动生成接口文档,给前端同事查看。

下载此包 Swashbuckle.AspNetCore

将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中:

P.S: .Net Core 3.1之后的版本  不用使用 new Info 要用 new OpenApiInfo

// 注册Swagger,定义一个和多个文档
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});

在 Startup.Configure 方法中,启用中间件为生成 Swagger。

// 启用中间件服务生成Swagger            
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "接口文档");
});

修改接口代码

     /// <summary>
/// 添加用户
/// </summary>
/// <param name="user">用户实体</param>
/// <returns></returns>
[HttpPost]
public async Task<string> Add(User user)
{
await _db.Set<User>().AddAsync(user);
await _db.SaveChangesAsync();
return "value";
} /// <summary>
/// 获取所有用户
/// </summary>
/// <returns>所有用户</returns>
[HttpGet]
public async Task<List<User>> GetList()
{
var list = await _db.Set<User>().ToListAsync();
return list;
}

打开网站 访问   XXXX/swagger/inedx.html 访问Swagger文档,接口信息成功显示

8. wagger显示接口注释

右键点击项目-属性-生成,输出xml文档文件,打钩,用于swagger调用显示注释。

打断点查看具体生成地址,此xml文件生成在这里

运行项目,查看,已经有了注释

9. 关闭需要输入注释的警告

项目中有些不想输入注释的地方也会提示要求输入注释!很烦 !

右键点击项目-属性,取消显示警告,添加1591

添加后重新运行项目,问题解决。

【Docker】 .Net Core 3.1 webapi 集成EF Code First,使用MySql进行业务操作 、配置swagger (三)的更多相关文章

  1. asp.net core 2.0 webapi集成signalr

    asp.net core 2.0 webapi集成signalr   在博客园也很多年了,一直未曾分享过什么东西,也没有写过博客,但自己也是汲取着博客园的知识成长的: 这两天想着不能这么无私,最近.N ...

  2. asp.net core 系列之webapi集成Dapper的简单操作教程

    Dapper也是是一种ORM框架 这里记录下,使用ASP.NET 集成 Dapper 的过程,方便自己查看 至于Dapper的特性以及操作可以参考Dapper官方文档 1.创建数据库相关 在Sql S ...

  3. asp.net core 系列之webapi集成EFCore的简单操作教程

    因为官网asp.net core webapi教程部分,给出的是使用内存中的数据即 UseInMemoryDatabase 的方式, 这里记录一下,使用SQL Server数据库的方式即 UseSql ...

  4. C# 之 .net core -- EF code first连接Mysql数据库

    一.在Models 新建两个数据库类 这个是数据库需要生成的类基础(塑造外观) public class User { [Key] public string ID { get; set; } [Ma ...

  5. EF Code First 连接MySql

    看了很多文章,尝试了很多次总是进行不下去,整理一下,以便日后查看. 1.创建ASP.NET MVC项目(EFCodeFirst) 1.1.右键点击引用选择管理NuGet程序包下载MySql.Data. ...

  6. ASP.NET Core 2.2 WebApi 系列【五】MiniProfiler与Swagger集成

    MiniProfiler 是一款性能分析的轻量级程序,可以基于action(request)记录每个阶段的耗时时长,还是可以显示访问数据库时的SQL(支持EF.EF Code First)等 一.安装 ...

  7. asp.net core系列 37 WebAPI 使用OpenAPI (swagger)中间件

    一.概述 在使用Web API时,对于开发人员来说,了解其各种方法可能是一项挑战.在ASP.NET Core上,Web api 辅助工具介绍二个中间件,包括:Swashbuckle和NSwag .NE ...

  8. WebApi 集成 Swagger

    1. Swagger(俗称:丝袜哥)是什么东西? Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同 ...

  9. mvc+webapi+dapper+ef codefirst项目搭建

    首先项目是mvc5+webapi2.0+orm数据处理(dapper)+ef动态创建数据库. 1.项目框架层次结构: mvc项目根据不同的业务和功能进行不同的区域划分[今后项目维护起来方便],mode ...

随机推荐

  1. ps怎么抠图并和另一张图片合并?

    1.首先打开PS.然后随便选取两张图片.比如下图我想把那个小花朵扣出来移动到另外一张图片上. 2.用套锁工具把那个小花朵扣出来.如图我标出了套锁工具的图标.以及扣出来的小花朵.这里也可以选择" ...

  2. CSS三大特性及权重叠加

    层叠性: 1.样式冲突,遵循的原则是就近原则,哪个样式离结构近,就执行哪个样式 2.样式不冲突,不会层叠 继承性: 子标签会继承父标签的某些样式,如文本颜色和字号 优先级: 当同一个元素指定多个选择器 ...

  3. CSS3:overflow属性详解

    1.Overflow overflow为溢出(容器),当内容超出容器时只需添加overflow属性值为hidden, 就可以把超出容器的部分隐藏起来: 如果内容超出容器却又不想其隐藏时可以将其属性值设 ...

  4. c++ 11字符串与string转换常用函数

    这里主要介绍一下string to int 其他方法与这个类似,可到头文件 <string> 中查看 @_Str 转换的字符串 @_Idx 转换的长度(位数) @_Base 进制 doub ...

  5. TCP/IP协议图解

    联网的各个终端之间能否进行交互的软件基础是网络协议栈,目前主流的网络协议栈是TCP/IP协议栈. 1.主机到网络层协议:以太网协议 主机到网络层主要为IP协议和ARP协议提供服务.发送和接收网络数据报 ...

  6. python3中的os.path模块

    os.path模块主要用于获取文件的属性,这里对该模块中一些常用的函数做些记录. os.abspath(path):获取文件的绝对路径.这里path指的是路径,例如我这里输入"data.cs ...

  7. xenserver使用ceph的rbd的方法

    首先安装的xenserver6.5的环境,看到有地方有提到这个上面可以安装rbd的支持,网上有一种方式是libvirt+kvm方式,因为ceph对libviet是原生支持的,但是xenserver底层 ...

  8. 源码分析:升级版的读写锁 StampedLock

    简介 StampedLock 是JDK1.8 开始提供的一种锁, 是对之前介绍的读写锁 ReentrantReadWriteLock 的功能增强.StampedLock 有三种模式:Writing(读 ...

  9. 每天一个linux命令之stat

    [Linux]Linux下使用stat命令所显示出来的三个时间 转 https://blog.csdn.net/pointer_y/article/details/54347968 在linux系统下 ...

  10. 为什么企业需要CRM系统?CRM的作用及其重要性分析

    客户管理系统(CRM)是企业核心应用软件之一,对于提高企业业绩起着至关重要的作用,现在很多企业都在客户发展方面投入大量的资金,以求获得更好的回报. 关于CRM CRM是一个客户数据中心,在CRM中,你 ...