BeautifulRestApi 项目使用教程

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

BeautifulRestApi/
├── src/
│   ├── BeautifulRestApi/
│   │   ├── Controllers/
│   │   ├── Models/
│   │   ├── Services/
│   │   ├── appsettings.json
│   │   ├── Program.cs
│   │   ├── Startup.cs
│   │   └── BeautifulRestApi.csproj
│   └── BeautifulRestApi.Tests/
├── .gitignore
├── LICENSE
├── README.md
└── BeautifulRestApi.sln

目录结构介绍

• src/BeautifulRestApi/: 项目的主要源代码目录。
  • Controllers/: 包含 API 控制器。
  • Models/: 包含数据模型。
  • Services/: 包含业务逻辑服务。
  • appsettings.json: 配置文件。
  • Program.cs: 应用程序的入口点。
  • Startup.cs: 配置服务和应用程序的请求管道。
  • BeautifulRestApi.csproj: 项目文件。
• src/BeautifulRestApi.Tests/: 包含项目的单元测试。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• BeautifulRestApi.sln: 解决方案文件。

2. 项目的启动文件介绍

Program.cs

Program.cs 是应用程序的入口点，负责配置和启动应用程序。

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

Startup.cs

Startup.cs 负责配置服务和应用程序的请求管道。

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        // 添加其他服务配置
    }

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

        app.UseRouting();

        app.UseAuthorization();

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

3. 项目的配置文件介绍

appsettings.json

appsettings.json 是应用程序的配置文件，包含各种配置选项。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

配置文件介绍

• Logging: 配置日志级别。
  • LogLevel: 指定不同类别的日志级别。
• AllowedHosts: 配置允许访问的主机。