EISK WebApi 项目教程

EISK WebApi 项目教程

eisk.webapiProject based on latest .NET (v6.0) technologies for building scalable web api, along with clean architecture patterns.项目地址:https://gitcode.com/gh_mirrors/ei/eisk.webapi

1. 项目的目录结构及介绍

EISK WebApi 项目的目录结构如下：

eisk.webapi/
├── Core/
│   ├── Domain/
│   └── Infrastructure/
│       └── EFCore/
├── WebApi/
│   └── Eisk WebApi/
├── .gitignore
├── Eisk WebApi.sln
├── LICENSE.txt
├── README.md

目录结构介绍

• Core/: 核心代码目录，包含项目的核心逻辑和业务规则。

  • Domain/: 存放领域模型和业务逻辑。
  • Infrastructure/: 存放基础设施代码，如数据访问层。
    • EFCore/: 使用 Entity Framework Core 实现数据访问。

• WebApi/: Web API 项目的根目录。

  • Eisk WebApi/: 具体的 Web API 项目文件夹，包含控制器、视图模型等。

• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。

• Eisk WebApi.sln: Visual Studio 解决方案文件。

• LICENSE.txt: 项目许可证文件。

• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 WebApi/Eisk WebApi/ 目录下，主要包括以下文件：

• Program.cs: 项目的入口文件，负责配置和启动 Web API 应用程序。
• Startup.cs: 配置应用程序的服务和中间件。

Program.cs

Program.cs 文件是项目的入口点，负责配置和启动 Web API 应用程序。以下是一个典型的 Program.cs 文件内容：

var builder = WebApplication.CreateBuilder(args);

// 添加服务到容器
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// 配置 HTTP 请求管道
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();

Startup.cs

Startup.cs 文件负责配置应用程序的服务和中间件。以下是一个典型的 Startup.cs 文件内容：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 添加服务到容器
        services.AddControllers();
        services.AddSwaggerGen();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
            app.UseSwagger();
            app.UseSwaggerUI();
        }

        app.UseHttpsRedirection();
        app.UseRouting();
        app.UseAuthorization();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

3. 项目的配置文件介绍

项目的配置文件通常位于项目的根目录或 WebApi/Eisk WebApi/ 目录下，主要包括以下文件：

• appsettings.json: 应用程序的配置文件，包含数据库连接字符串、日志配置等。
• appsettings.Development.json: 开发环境的配置文件，通常用于覆盖默认配置。

appsettings.json

appsettings.json 文件是应用程序的主要配置文件，包含数据库连接字符串、日志配置等。以下是一个典型的 appsettings.json 文件内容：

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=EiskDb;User Id=sa;Password=your_password;"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

appsettings.Development.json

appsettings.Development.json 文件用于开发环境的配置，通常用于覆盖默认配置。以下是一个典型的 appsettings.Development.json 文件内容：

{
  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  }
}

通过以上配置文件，可以灵活地管理应用程序的配置，确保在不同环境下都能正常运行。

eisk.webapiProject based on latest .NET (v6.0) technologies for building scalable web api, along with clean architecture patterns.项目地址:https://gitcode.com/gh_mirrors/ei/eisk.webapi