aspnet api

Aspnet-api

最小ASP.NET核心API

要求

• .NET 8.0 SDK
• 一个MySQL数据库

特征

• Openapi
• 依赖注入容器（自动引导）
• 单个动作控制器，服务和存储库
• 特定环境配置
• 12因子.env配置加载器（敏感数据）
• MySQL数据库连接
• SQL QueryBuilder（SQLKATA）
• 数据库交易处理
• 输入验证（Fulentvalidation）
• 验证Exception中间件
• 本地化（ngetText）
• 上下文特定的日志记录（Serilog）
• 基于文件的错误记录
• 连续集成（CI）与GitHub动作的工作流程
• 数据库迁移（DBUP）

测试

• Xunit测试
• HTTP端点测试（使用测试数据库）
• 日志消息的流利断言

托多

• 数据库测试的流利断言
• 身份验证（BasicAuth）
• 构建脚本

安装

运行以下命令创建一个新项目：

 git clone https://github.com/odan/aspnet-api.git --depth 1 {my-app-name}
cd {my-app-name}

用项目的所需名称替换{my-app-name} 。

创建一个新的MySQL / MariadB数据库。

 CREATE DATABASE ` my_api ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

相应地修改数据库名称。

在MyApi目录中创建.env文件：

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api

相应地修改数据库和凭据。

手动导入schema.sql文件或运行以下命令：

 npm run migration:migrate

注意：此命令需要NPM。

命令

要以调试模式构建和运行应用程序，请运行：

 dotnet run

或者

 dotnet watch run

运行发布版本：

 dotnet run --configuration Release

建立一个项目及其依赖性：

 dotnet build

使用发布配置构建项目及其依赖关系：

 dotnet build --configuration Release

清洁垃圾箱和OBJ目录：

 dotnet clean

清洁和建造：

 dotnet rebuild

发布：

 dotnet publish

代码样式

安装dotnet-format软件包：

 dotnet tool install --global dotnet-format 

检查代码样式：

 dotnet format --verify-no-changes

修复代码样式：

 dotnet format -v d

翻译

声明您需要翻译消息的IStringLocalizer<T>接口。

例子

 public class Example
{
    private readonly IStringLocalizer < Example > _localizer ;

    public Example ( IStringLocalizer < Example > localizer )
    {
        _localizer = localizer ;
    }

    // ...
}

翻译用法

默认语言和源语言是英语。

翻译一个简单的消息：

 string text = _localizer . GetString ( "Hello, World!" ) ;

// Output: Hallo, Welt!

与占位符的消息翻译一条消息：

 string text2 = _localizer . GetString ( "The user {0} logged in" , "sally" ) ;

// Output: Der Benutzer sally hat sich eingeloggt

创建一个新的翻译文件

• 打开poedit并在项目Resources目录中创建一个新的PO翻译文件。
• 文件名必须与文化名称相同，例如de-DE.po 。
• 打开菜单Translations > Settings
• 更改PO语言，例如German
• 添加_localizer.GetString作为源关键字。
• 使用您的项目CS文件添加源路径。
• 保存文件，然后单击Update from source以解析新的翻译。
• 翻译消息并保存文件以生成mo文件，例如de-DE.mo 。

改变语言

您可以通过设置当前文化在请求期间更改语言，如下所示：

 using using System . Globalization ;
// ...

var culture = new CultureInfo ( "de-DE" ) ;
Thread . CurrentThread . CurrentCulture = culture ;
Thread . CurrentThread . CurrentUICulture = culture ;

LocalizationMiddleware使用HTTP请求Accept-Language标头值来检测用户语言。如果此标头包含有效的代码，则将自动切换当前文化。

测试

为Xunit创建本地测试数据库。

 CREATE DATABASE ` my_api_test ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

在MyApi.Tests目录中创建.env文件：

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api_test

相应地修改数据库和凭据。

要启动测试套件，请运行：

 dotnet test

执照

麻省理工学院许可证（麻省理工学院）。请参阅许可证文件以获取更多信息。