银行API项目安装与配置指南

银行API项目安装与配置指南

bank-api The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API. 项目地址: https://gitcode.com/gh_mirrors/ba/bank-api

1. 项目基础介绍

银行API项目是一个设计参考项目，旨在帮助开发者快速启动一个符合规范且现代化的API开发。该项目遵循了多项安全规范和标准，适用于构建符合OWASP API安全十大标准、OpenAPI规范、加州消费者隐私法案（CCPA）和通用数据保护条例（GDPR）的API。

该项目主要使用C#编程语言，基于.NET Core框架开发。

2. 项目使用的关键技术和框架

• .NET Core 9.0: 用于API开发的基础框架。
• ASP.NET Core Minimal API: 简化的API开发模式。
• Resilience: 用于调用下游API时的弹性处理。
• Compliance: 用于敏感数据脱敏。
• Health Checks: 用于检查健康状态。
• Service Discovery: 用于从配置中解析端点。
• Hybrid Cache: 用于缓存。
• Rate Limiting: 用于限制请求频率。
• API Key, JWT Bearer, OpenID Connect: 用于安全性认证。
• OpenApi: 用于生成OpenAPI规范。
• CORS: 用于处理跨源请求。
• OpenTelemetry (OTel): 用于可观测性。
• .NET Aspire: 用于开发启动和客户端集成。
• Kiota API Client Generation: 用于调用下游API的客户端生成。
• Gridify: 用于过滤、排序和分页。
• Scalar: 用于交互式API文档。
• Spectral: 用于代码风格检查。
• Swashbuckle.AspNetCore: 用于解析JSON到IOpenApiAny类型。
• TUnit: 用于单元测试。

3. 项目安装和配置的准备工作

在开始安装和配置之前，请确保您的系统已经安装以下软件：

• .NET 9 SDK: 从官方网站下载并安装.NET 9 SDK。
• Visual Studio Code: 安装VS Code以及以下扩展：
  • C# for Visual Studio Code
  • REST Client
  • Spectral

4. 项目安装步骤

1. 克隆项目仓库: 使用Git命令克隆项目仓库到本地环境：

   git clone https://github.com/erwinkramer/bank-api.git
   cd bank-api
   

2. 安装依赖: 在项目目录中，运行以下命令安装所有依赖项：

   dotnet restore
   

3. 生成JWT令牌: 在项目目录中，运行以下命令生成一个新的JWT令牌，用于安全端点：

   dotnet user -jwts create --scope "bank_api" --role "banker" --project BankApi.Service.Stable
   

4. 构建项目: 运行以下命令构建项目，并输出OpenAPI定义：

   dotnet build
   

5. 验证OpenAPI定义: 打开openapi_v1.json文件，并使用Spectral扩展检查问题。

6. 运行API: 根据需要选择以下两种运行方式之一：

   • Aspire最小模式: 运行以下命令启动ASP.NET Core API：

     docker run -rm -it -p 18888:18888 -p 4317:18889 --name aspire-dashboard mcr.microsoft.com/dotnet/aspire-dashboard:latest
     

     在浏览器中打开输出的URL（将0.0.0.0替换为localhost）。

   • Aspire模式: 确保Docker运行时已启动，然后运行以下命令启动API：

     dotnet run -c Release --project ./BankApi.Service.Stable
     

完成以上步骤后，您应该已经成功安装和配置了银行API项目，并可以开始开发和测试了。

bank-api The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API. 项目地址: https://gitcode.com/gh_mirrors/ba/bank-api