Swashbuckle.Examples 项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00880/article/details/142021347

Swashbuckle.Examples 项目使用教程

Swashbuckle.ExamplesAdds the [SwaggerRequestExample] and [SwaggerResponseExample] attributes to Swashbuckle项目地址:https://gitcode.com/gh_mirrors/sw/Swashbuckle.Examples

1. 项目目录结构及介绍

Swashbuckle.Examples/
├── WebApi/
│   ├── Controllers/
│   ├── Models/
│   ├── Properties/
│   ├── appsettings.json
│   ├── Program.cs
│   ├── Startup.cs
│   └── WebApi.csproj
├── tools/
│   └── gitignore
├── .gitignore
├── LICENSE
├── README.md
└── Swashbuckle.Examples.sln

目录结构说明

WebApi/: 项目的主要代码目录，包含控制器、模型、配置文件等。
- Controllers/: 存放API控制器的目录。
- Models/: 存放数据模型的目录。
- Properties/: 存放项目属性的目录。
- appsettings.json: 项目的配置文件。
- Program.cs: 项目的启动文件。
- Startup.cs: 项目的配置启动文件。
- WebApi.csproj: 项目的项目文件。
tools/: 存放工具文件的目录。
.gitignore: Git忽略文件配置。
LICENSE: 项目许可证文件。
README.md: 项目说明文件。
Swashbuckle.Examples.sln: 项目的解决方案文件。

2. 项目的启动文件介绍

Program.cs

Program.cs 是项目的启动文件，负责配置和启动Web应用程序。以下是文件的主要内容：

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

namespace WebApi
{
    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>();
                });
    }
}

主要功能

Main方法: 项目的入口点，调用CreateHostBuilder方法创建并运行Web主机。
CreateHostBuilder方法: 配置Web主机的默认设置，并指定Startup类作为启动配置类。

3. 项目的配置文件介绍

appsettings.json

appsettings.json 是项目的配置文件，用于存储应用程序的配置信息。以下是文件的主要内容：

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

主要配置项

Logging: 配置日志记录的级别。
- Default: 默认日志级别为Information。
- Microsoft: Microsoft相关日志级别为Warning。
- Microsoft.Hosting.Lifetime: 主机生命周期日志级别为Information。
AllowedHosts: 允许访问的主机列表，*表示允许所有主机访问。

Startup.cs

Startup.cs 是项目的配置启动文件，负责配置应用程序的服务和中间件。以下是文件的主要内容：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

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

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddSwaggerGen();
        }

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

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

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

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });
        }
    }
}