novawebmobi/usersapi

Users-Api

镜像概述和主要用途

Users-Api是NovaWeb项目的用户控制API，用于管理用户数据。该API提供RESTful接口，支持标准HTTP方法，可通过Swagger文档查看所有端点，适用于需要用户管理功能的NovaWeb相关项目。

核心功能和特性

• RESTful接口：支持GET、POST、PUT、DELETE等HTTP方法
• 协议支持：仅支持HTTP协议（暂不支持HTTPS）
• API路径格式：PROTOCOL://URI/VERSION/ENDPOINT，示例：http://usersapi.digitalingresso.dev.novaweb.mobi/v1/users
• 文档支持：提供Swagger文档，访问地址：http://usersapi.digitalingresso.dev.novaweb.mobi/swagger
• 技术栈：基于.NET Core 3.1构建，使用Entity Framework Core进行对象建模，支持MySQL数据库（通过Pomelo EF Core），实现通知模式（Flunt）

使用场景和适用范围

适用于NovaWeb项目中需要用户数据CRUD（创建、读取、更新、删除）操作的场景，可作为用户管理模块集成到各类应用中。

详细使用方法和配置说明

前置要求

• 安装.NET Core 3.1 SDK：.NET Core 3.1 SDK
• 了解.NET Core基础知识：.NET Core 文档

验证SDK安装：

bash
dotnet --version

环境配置与依赖安装

需安装以下依赖包：

• Entity Framework Core：对象建模
• ASP.NET Core：API基础框架
• Flunt：通知模式实现
• Pomelo Entity Framework Core：MySQL支持
• Swashbuckle：API文档生成

安装命令：

bash
dotnet add package Flunt
dotnet add package Microsoft.AspNetCore.Authentication
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
dotnet add package Microsoft.EntityFrameworkCore
dotnet add package Microsoft.EntityFrameworkCore.Tools
dotnet add package Microsoft.EntityFrameworkCore.Relational
dotnet add package Microsoft.Extensions.Configuration
dotnet add package Pomelo.EntityFrameworkCore.MySql
dotnet add package Swashbuckle.AspNetCore

或通过以下命令恢复所有依赖：

bash
dotnet restore

运行测试

执行单元测试和静态测试：

bash
dotnet test Users-Api.sln

测试采用Red Green Refactor方法论。

部署指南

以下部署步骤假设已具备GCP CloudSQL MySQL实例和安装了Ambassador的GKE集群。

1. 创建命名空间

bash
kubectl create namespace <NAMESPACE>

2. 添加Docker Hub凭证

bash
kubectl create secret -n <NAMESPACE> docker-registry novaweb-secrets --docker-username=<USERNAME> --docker-password=<PASSWD> --docker-email=<EMAIL>

3. 配置部署 Secrets

1. 复制deploysecrets-template.txt模板，填写必要参数后保存为deploysecrets.yaml（需指定命名空间）
2. 应用配置：

bash
kubectl apply -f deploysecrets.yaml

4. 创建CloudSQL代理服务账户

bash
gcloud iam service-accounts keys create ~/key.json --iam-account <NOME_DA_CONTA>@project-id.iam.gserviceaccount.com
kubectl create secret generic sa-secret --from-file=service_account.json=~/key.json

需在GCP IAM控制台为该账户授权CloudSQL访问权限。

5. 部署API实例

1. 复制template.txt模板，填写必要参数后保存为deployment.yaml（指定正确命名空间）
2. 应用部署配置：

bash
kubectl apply -f deployment.yaml

6. 检查部署状态

bash
kubectl get all -n <NAMESPACE>

预期输出示例：

NAME                               READY   STATUS    RESTARTS   AGE
pod/usersapi-694c7f5c9d-4x6n9      2/2     Running   0          15m

NAME                  TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)     AGE
service/usersapi      ClusterIP   10.0.xx.xx   <none>        20000/TCP   78m

NAME                          READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/usersapi      1/1     1            1           78m

NAME                                     DESIRED   CURRENT   READY   AGE
replicaset.apps/usersapi-694c7f5c9d      1         1         1       33m

NAME                                              REFERENCE                TARGETS         MINPODS   MAXPODS   REPLICAS   AGE
horizontalpodautoscaler.autoscaling/usersapi      Deployment/usersapi      <unknown>/90m   1         3         1          78m

7. 配置Ambassador外部访问

1. 复制mapping-template.txt模板，填写DNS域名（需指向Ambassador Load***外部IP）后保存为mapping.yaml
2. 应用配置：

bash
kubectl apply -f mapping.yaml

版本控制

采用SemVer进行版本管理，版本信息可查看项目标签。

许可证

本项目采用MIT许可证，详见LICENSE.md。