AI 助理
备案控制台
开发者社区 数据库 文章 正文

七天.NET 8操作SQLite入门到实战 - 第六天后端班级管理相关接口完善和Swagger自定义配置

2023-12-14 150
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 七天.NET 8操作SQLite入门到实战 - 第六天后端班级管理相关接口完善和Swagger自定义配置

前言

在上一章节我们在后端框架中引入 SQLite-net ORM 并封装常用方法（SQLiteHelper），今天我们的任务是设计好班级管理相关的表、完善后端班级管理相关接口并对Swagger自定义配置。

七天.NET 8 操作 SQLite 入门到实战详细教程

EasySQLite 项目源码地址

班级管理相关的表设计

班级表的字段可以包括：

  1. 班级ID（ClassID）：用于唯一标识每个班级[主键自增]。
  2. 班级名称（ClassName）：班级的名称。
  3. 创建时间（CreateTime）：班级创建的时间。

班级学生表的字段可以包括：

  1. 学生ID（StudentID）：用于唯一标识每个学生[主键自增]。
  2. 班级ID（ClassID）：所属班级的ID，与班级表中的班级ID相关联。
  3. 姓名（Name）：学生的姓名。
  4. 年龄（Age）：学生的年龄。
  5. 性别（Gender）：学生的性别。

班级管理相关的表对应模型

SchoolClass

public class SchoolClass
    {
        /// <summary>
        /// 班级ID [主键，自动递增]
        /// </summary>
        [PrimaryKey, AutoIncrement]
        public int ClassID { get; set; }
        /// <summary>
        /// 班级名称
        /// </summary>
        public string ClassName { get; set; }
        /// <summary>
        /// 创建时间
        /// </summary>
        public DateTime CreateTime { get; set; }
    }

Student

public class Student
    {
        /// <summary>
        /// 学生ID [主键，自动递增]
        /// </summary>
        [PrimaryKey, AutoIncrement]
        public int StudentID { get; set; }
        /// <summary>
        /// 班级ID
        /// </summary>
        public int ClassID { get; set; }
        /// <summary>
        /// 学生姓名
        /// </summary>
        public string Name { get; set; }
        /// <summary>
        /// 学生年龄
        /// </summary>
        public int Age { get; set; }
        /// <summary>
        /// 学生性别
        /// </summary>
        public string Gender { get; set; }
    }

接口统一的响应模型

为了实现统一的响应模型，这里创建一个名为 ApiResponse的泛型类。

public class ApiResponse<T>
    {
        /// <summary>
        /// 是否成功
        /// </summary>
        public bool Success { get; set; }
        /// <summary>
        /// 响应消息
        /// </summary>
        public string Message { get; set; }
        /// <summary>
        /// 返回的数据
        /// </summary>
        public T Data { get; set; }
    }

学校班级管理接口代码

/// <summary>
    /// 学校班级管理
    /// </summary>
    [ApiController]
    [Route("[controller]")]
    public class SchoolClassController : ControllerBase
    {
        private readonly SQLiteAsyncHelper<SchoolClass> _schoolClassHelper;
        /// <summary>
        /// 依赖注入
        /// </summary>
        /// <param name="schoolClassHelper">schoolClassHelper</param>
        public SchoolClassController(SQLiteAsyncHelper<SchoolClass> schoolClassHelper)
        {
            _schoolClassHelper = schoolClassHelper;
        }
        /// <summary>
        /// 班级创建
        /// </summary>
        /// <param name="schoolClass">创建班级信息</param>
        /// <returns></returns>
        [HttpPost]
        public async Task<ApiResponse<int>> CreateClass([FromBody] SchoolClass schoolClass)
        {
            try
            {
                int insertNumbers = await _schoolClassHelper.InsertAsync(schoolClass);
                if (insertNumbers > 0)
                {
                    return new ApiResponse<int>
                    {
                        Success = true,
                        Message = "创建班级成功"
                    };
                }
                else
                {
                    return new ApiResponse<int>
                    {
                        Success = false,
                        Message = "创建班级失败"
                    };
                }
            }
            catch (Exception ex)
            {
                return new ApiResponse<int>
                {
                    Success = false,
                    Message = ex.Message
                };
            }
        }
        /// <summary>
        /// 获取所有班级信息
        /// </summary>
        [HttpGet]
        public async Task<ApiResponse<List<SchoolClass>>> GetClasses()
        {
            try
            {
                var classes = await _schoolClassHelper.QueryAllAsync().ConfigureAwait(false);
                return new ApiResponse<List<SchoolClass>>
                {
                    Success = true,
                    Data = classes
                };
            }
            catch (Exception ex)
            {
                return new ApiResponse<List<SchoolClass>>
                {
                    Success = false,
                    Message = ex.Message
                };
            }
        }
        /// <summary>
        /// 根据班级ID获取班级信息
        /// </summary>
        /// <param name="classId">班级ID</param>
        /// <returns></returns>
        [HttpGet("{classId}")]
        public async Task<ApiResponse<SchoolClass>> GetClass(int classId)
        {
            try
            {
                var schoolClass = await _schoolClassHelper.QuerySingleAsync(c => c.ClassID == classId).ConfigureAwait(false);
                if (schoolClass != null)
                {
                    return new ApiResponse<SchoolClass>
                    {
                        Success = true,
                        Data = schoolClass
                    };
                }
                else
                {
                    return new ApiResponse<SchoolClass>
                    {
                        Success = false,
                        Message = "班级不存在"
                    };
                }
            }
            catch (Exception ex)
            {
                return new ApiResponse<SchoolClass>
                {
                    Success = false,
                    Message = ex.Message
                };
            }
        }
        /// <summary>
        /// 更新班级信息
        /// </summary>
        /// <param name="classId">班级ID</param>
        /// <param name="updatedClass">更新的班级信息</param>
        /// <returns></returns>
        [HttpPut("{classId}")]
        public async Task<ApiResponse<int>> UpdateClass(int classId, [FromBody] SchoolClass updatedClass)
        {
            try
            {
                var existingClass = await _schoolClassHelper.QuerySingleAsync(c => c.ClassID == classId).ConfigureAwait(false);
                if (existingClass != null)
                {
                    existingClass.ClassName = updatedClass.ClassName;
                    var updateResult = await _schoolClassHelper.UpdateAsync(existingClass).ConfigureAwait(false);
                    if (updateResult > 0)
                    {
                        return new ApiResponse<int>
                        {
                            Success = true,
                            Message = "班级信息更新成功"
                        };
                    }
                    else
                    {
                        return new ApiResponse<int>
                        {
                            Success = false,
                            Message = "班级信息更新失败"
                        };
                    }
                }
                else
                {
                    return new ApiResponse<int>
                    {
                        Success = false,
                        Message = "班级不存在"
                    };
                }
            }
            catch (Exception ex)
            {
                return new ApiResponse<int>
                {
                    Success = false,
                    Message = ex.Message
                };
            }
        }
        /// <summary>
        /// 班级删除
        /// </summary>
        /// <param name="classId">班级ID</param>
        /// <returns></returns>
        [HttpDelete("{classId}")]
        public async Task<ApiResponse<int>> DeleteClass(int classId)
        {
            try
            {
                var deleteResult = await _schoolClassHelper.DeleteAsync(classId).ConfigureAwait(false);
                if (deleteResult > 0)
                {
                    return new ApiResponse<int>
                    {
                        Success = true,
                        Message = "班级删除成功"
                    };
                }
                else
                {
                    return new ApiResponse<int>
                    {
                        Success = true,
                        Message = "班级删除失败"
                    };
                }
            }
            catch (Exception ex)
            {
                return new ApiResponse<int>
                {
                    Success = false,
                    Message = ex.Message
                };
            }
        }
    }

学生管理接口代码

/// <summary>
    /// 学生管理
    /// </summary>
    [ApiController]
    [Route("[controller]")]
    public class StudentController : ControllerBase
    {
        private readonly SQLiteAsyncHelper<Student> _studentHelper;
        /// <summary>
        /// 依赖注入
        /// </summary>
        /// <param name="studentHelper">studentHelper</param>
        public StudentController(SQLiteAsyncHelper<Student> studentHelper)
        {
            _studentHelper = studentHelper;
        }
        /// <summary>
        /// 创建新的学生记录
        /// </summary>
        /// <param name="student">添加的学生信息</param>
        /// <returns></returns>
        [HttpPost]
        public async Task<ApiResponse<int>> CreateAsync([FromBody] Student student)
        {
            var response = new ApiResponse<int>();
            try
            {
                var insertNumbers = await _studentHelper.InsertAsync(student).ConfigureAwait(false);
                if (insertNumbers > 0)
                {
                    response.Success = true;
                    response.Message = "添加成功";
                }
                else
                {
                    response.Success = false;
                    response.Message = "插入失败";
                }
            }
            catch (Exception ex)
            {
                response.Success = false;
                response.Message = ex.Message;
            }
            return response;
        }
        /// <summary>
        /// 查询所有学生记录
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public async Task<ApiResponse<List<Student>>> GetAllAsync()
        {
            var response = new ApiResponse<List<Student>>();
            try
            {
                var students = await _studentHelper.QueryAllAsync().ConfigureAwait(false);
                response.Success = true;
                response.Data = students;
            }
            catch (Exception ex)
            {
                response.Success = false;
                response.Message = ex.Message;
            }
            return response;
        }
        /// <summary>
        /// 根据学生ID查询学生信息
        /// </summary>
        /// <param name="studentID">学生ID</param>
        /// <returns></returns>
        [HttpGet("{studentID}")]
        public async Task<ApiResponse<Student>> GetByIdAsync(int studentID)
        {
            var response = new ApiResponse<Student>();
            try
            {
                var student = await _studentHelper.QuerySingleAsync(x => x.StudentID == studentID).ConfigureAwait(false);
                if (student != null)
                {
                    response.Success = true;
                    response.Data = student;
                }
                else
                {
                    response.Success = false;
                    response.Message = "未找到学生信息";
                }
            }
            catch (Exception ex)
            {
                response.Success = false;
                response.Message = ex.Message;
            }
            return response;
        }
        /// <summary>
        /// 更新学生记录
        /// </summary>
        /// <param name="studentID">学生ID</param>
        /// <param name="editstudent">更新的学生信息</param>
        /// <returns></returns>
        [HttpPut("{studentID}")]
        public async Task<ApiResponse<int>> UpdateAsync(int studentID, [FromBody] Student editstudent)
        {
            var response = new ApiResponse<int>();
            try
            {
                var student = await _studentHelper.QuerySingleAsync(x => x.StudentID == studentID).ConfigureAwait(false);
                if (student != null)
                {
                    student.Age = editstudent.Age;
                    student.Name = editstudent.Name;
                    student.Gender = editstudent.Gender;
                    student.ClassID = editstudent.ClassID;
                    int updateResult = await _studentHelper.UpdateAsync(student).ConfigureAwait(false);
                    if (updateResult > 0)
                    {
                        response.Success = true;
                        response.Message = "学生信息更新成功";
                    }
                    else
                    {
                        response.Success = false;
                        response.Message = "学生信息更新失败";
                    }
                }
                else
                {
                    response.Success = false;
                    response.Message = "未找到学生信息";
                }
            }
            catch (Exception ex)
            {
                response.Success = false;
                response.Message = ex.Message;
            }
            return response;
        }
        /// <summary>
        /// 删除学生记录
        /// </summary>
        /// <param name="studentID">学生ID</param>
        /// <returns></returns>
        [HttpDelete("{studentID}")]
        public async Task<ApiResponse<int>> DeleteAsync(int studentID)
        {
            var response = new ApiResponse<int>();
            try
            {
                int deleteResult = await _studentHelper.DeleteAsync(studentID).ConfigureAwait(false);
                if (deleteResult > 0)
                {
                    response.Success = true;
                    response.Message = "删除成功";
                }
                else
                {
                    response.Success = false;
                    response.Message = "未找到学生信息";
                }
            }
            catch (Exception ex)
            {
                response.Success = false;
                response.Message = ex.Message;
            }
            return response;
        }
    }

对应服务注册

在Program.cs类中：

// 注册服务
builder.Services.AddScoped<SQLiteAsyncHelper<SchoolClass>>();
builder.Services.AddScoped<SQLiteAsyncHelper<Student>>();

Swagger自定义和扩展

Swagger 提供了为对象模型进行归档和自定义 UI 以匹配你的主题的选项。

传递给 AddSwaggerGen 方法的配置操作会添加诸如作者、许可证和说明的信息。在 Program.cs 中添加如下Swagger自定义配置：

// 添加Swagger服务
            builder.Services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "EasySQLite API",
                    Version = "V1",
                    Description = ".NET 8操作SQLite入门到实战",
                    Contact = new OpenApiContact
                    {
                        Name = "GitHub源码地址",
                        Url = new Uri("https://github.com/YSGStudyHards/EasySQLite")
                    }
                });
                // 获取xml文件名
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                // 获取xml文件路径
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 添加控制器层注释，true表示显示控制器注释
                options.IncludeXmlComments(xmlPath, true);
                // 对action的名称进行排序，如果有多个，就可以看见效果了
                options.OrderActionsBy(o => o.RelativePath);
            });

项目右键，选择属性，找到生成下面的输出选中生成包含API文档的文件，如下图所示：

注意：关于XML文档文件路径是需要你先勾选上面生成包含API文档的文件的时候运行项目才会生成该项目的XML文档，然后可以把生成的XML文档放到你想要放到的位置。

项目运行：

Swagger API调用效果展示

Navicat查看SQLite数据库表数据

注意本文我们的数据库和表都是由代码自动创建生成的，也就是在SQLiteAsyncHelper里面。

创建成功后的数据库：

Navicat查看数据库表数据

文章标签：
数据库管理
数据库
API
数据格式
XML
关键词：
Swagger配置
后端接口
入门Swagger
后端配置
.NET swagger
追逐时光者
目录
相关文章
蓝易云
|
2月前
|
Java API Maven
SpringBootWeb篇-入门了解Swagger的具体使用
通过上述步骤，您可以在 Spring Boot 项目中快速集成和使用 Swagger。Swagger 提供了简洁的配置和强大的功能，使得 API 文档的生成和测试变得非常方便。通过 Swagger 的注解，开发者可以清晰地描述 API 的功能，提高文档的可读性和可维护性。通过访问 Swagger UI，您可以直观地查看和测试 API，极大地提升开发效率。
蓝易云
54 7
追逐时光者
|
3月前
|
开发框架 搜索推荐 算法
一个包含了 50+ C#/.NET编程技巧实战练习教程
一个包含了 50+ C#/.NET编程技巧实战练习教程
追逐时光者
161 18
天下无贼001
|
4月前
|
缓存 安全 前端开发
构建高效后端服务：从理论到实战
在数字化浪潮的推动下，后端服务成为了支撑现代互联网应用的核心。本文旨在揭示如何打造一个既可靠又高效的后端系统，从基础架构设计、代码组织、性能优化到安全防护，全方位解析后端开发的艺术。通过实际代码示例和深入浅出的解释，引导读者理解并掌握后端开发的关键技术点。
天下无贼001
124 6
mrq4nk6ni2neg
|
4月前
|
存储 SQL 数据库
深入浅出后端开发之数据库优化实战
【10月更文挑战第35天】在软件开发的世界里，数据库性能直接关系到应用的响应速度和用户体验。本文将带你了解如何通过合理的索引设计、查询优化以及恰当的数据存储策略来提升数据库性能。我们将一起探索这些技巧背后的原理，并通过实际案例感受优化带来的显著效果。
mrq4nk6ni2neg
87 4
土木林森
|
4月前
|
运维 NoSQL Java
后端架构演进：微服务架构的优缺点与实战案例分析
【10月更文挑战第28天】本文探讨了微服务架构与单体架构的优缺点，并通过实战案例分析了微服务架构在实际应用中的表现。微服务架构具有高内聚、低耦合、独立部署等优势，但也面临分布式系统的复杂性和较高的运维成本。通过某电商平台的实际案例，展示了微服务架构在提升系统性能和团队协作效率方面的显著效果，同时也指出了其带来的挑战。
土木林森
157 4
lqj_本人
|
4月前
|
JavaScript API 开发工具
＜大厂实战场景＞ ~ Flutter&鸿蒙next 解析后端返回的 HTML 数据详解
本文介绍了如何在 Flutter 中解析后端返回的 HTML 数据。首先解释了 HTML 解析的概念，然后详细介绍了使用 `http` 和 `html` 库的步骤，包括添加依赖、获取 HTML 数据、解析 HTML 内容和在 Flutter UI 中显示解析结果。通过具体的代码示例，展示了如何从 URL 获取 HTML 并提取特定信息，如链接列表。希望本文能帮助你在 Flutter 应用中更好地处理 HTML 数据。
lqj_本人
177 1
追逐时光者
|
5月前
|
开发框架 NoSQL MongoDB
C#/.NET/.NET Core开发实战教程集合
C#/.NET/.NET Core开发实战教程集合
追逐时光者
110 1
小王老师呀
|
4月前
|
消息中间件 开发框架 .NET
.NET 8 强大功能 IHostedService 与 BackgroundService 实战
【11月更文挑战第7天】本文介绍了 ASP.NET Core 中的 `IHostedService` 和 `BackgroundService` 接口及其用途。`IHostedService` 定义了 `StartAsync` 和 `StopAsync` 方法，用于在应用启动和停止时执行异步操作，适用于资源初始化和清理等任务。`BackgroundService` 是 `IHostedService` 的抽象实现，简化了后台任务的编写，通过 `ExecuteAsync` 方法实现长时间运行的任务逻辑。文章还提供了创建和注册这两个服务的实战步骤，帮助开发者在实际项目中应用这些功能。
小王老师呀
184 0
nanshaws
|
5月前
|
Java API Spring
Springfox Swagger3从入门案例
本文通过一个简单的案例介绍了如何在Spring Boot项目中使用Springfox Swagger3来生成和配置API文档，包括添加依赖、创建配置类、编写控制器类以及访问Swagger UI界面。
nanshaws
168 0
Springfox Swagger3从入门案例
lqj_本人
|
4月前
|
JSON Dart 数据格式
＜大厂实战场景＞ ~ flutter&鸿蒙next处理后端返回来的数据的转义问题
在 Flutter 应用开发中，处理后端返回的数据是常见任务，尤其涉及转义字符时。本文详细探讨了如何使用 Dart 的 `dart:convert` 库解析包含转义字符的 JSON 数据，并提供了示例代码和常见问题的解决方案，帮助开发者有效处理数据转义问题。
lqj_本人
224 0

热门文章

最新文章

  • 1
    .NET 平台 SM2 国密算法 License 证书生成深度解析
  • 2
    【Azure Fabric Service】演示使用PowerShell命令部署SF应用程序(.NET)
  • 3
    .net8 使用 license 证书授权案例解析
  • 4
    D1net阅闻 | 微软CEO对话特朗普和马斯克：豪掷800亿美元建AI数据中心
  • 5
    D1net阅闻｜据悉微软致力于在365 Copilot产品中添加非OpenAI模型
  • 6
    D1net阅闻｜DeepSeek开源放大招：FlashMLA让H800算力狂飙！曝光低成本秘笈
  • 7
    D1net阅闻 | 李飞飞团队训练出媲美DeepSeek R1的推理模型 云计算费用不到50美元
  • 8
    .NET 10首个预览版发布：重大改进与新特性概览！
  • 9
    D1net阅闻 | 美国禁止向中国出口GPU：发布全球AI出口限令
  • 10
    D1net阅闻 | 普华永道发布2025年AI预测：AI Agents将生产力提升1倍
  • 1
    深入了解SQLite3命令：小巧强大的数据库工具
    384
  • 2
    技术好文共享：（xxxx）十一：SQLite3的db数据库解密（三）数据库在线备份
    323
  • 3
    Android之SQLite数据库使用详解
    778
  • 4
    在 Android Studio 中结合使用 SQLite 数据库实现简单的注册和登录功能
    324
  • 5
    在 Android Studio 中结合使用 SQLite 数据库实现简单的注册和登录功能
    288
  • 6
    Linux上sqlite的安装和使用方法以及在QT中如何使用sqlite&笔记总结
    1227
  • 7
    【sqlite的C语言访问接口】执行SQL语句的接口------sqlite3_exec回调函数的使用
    279
  • 8
    CentOS7编译安装Python3.10（含OpenSSL1.1.1安装），创建虚拟环境，运行Django项目（含sqlite版本报错）
    970
  • 9
    17. Python 数据库操作之MySQL和SQLite实例
    274
  • 10
    MySQL 迁移至 SQLite 问题记录
    363

    • 相关课程

    更多
  • PHP进阶教程 - 由浅入深掌握面向对象开发 - 第二阶段

    • 相关电子书

    更多
  • 微信SQLite数据库损坏恢复实践
  • 十分钟上线-使用函数计算构建支付宝小程序服务
  • 机器学习在互联网后端技术中的应用
    • 下一篇
    阿里云oss简介和如何对接使用