ASP.NET Core中引用OpenAPI服务的添加示例

OpenAPI是一种用于描述RESTful API的规范。在ASP.NET Core中，可以使用Swashbuckle.AspNetCore包来生成OpenAPI文档。本攻略将提供一些示例，演示如何在ASP.NET Core中引用OpenAPI服务。

步骤

步骤1：创建一个新的ASP.NET Core Web API项目

首先，需要创建一个新的ASP.NET Core Web API项目。可以使用以下命令在命令行中创建一个新的ASP.NET Core Web API项目：

dotnet new webapi -n MyWebApi

在上面的命令中，使用 dotnet new 命令创建一个新的Web API项目。使用 -n 参数指定项目的名称为 MyWebApi。

步骤2：安装Swashbuckle.AspNetCore包

接下来，需要安装Swashbuckle.AspNetCore包。可以使用以下命令在命令行中安装Swashbuckle.AspNetCore包：

dotnet add package Swashbuckle.AspNetCore

在上面的命令中，使用 dotnet add package 命令安装Swashbuckle.AspNetCore包。

步骤3：配置Swashbuckle.AspNetCore

现在，需要配置Swashbuckle.AspNetCore。可以在 Startup.cs 文件中添加以下代码：

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

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

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "MyWebApi", Version = "v1" });
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseSwagger();

    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyWebApi v1");
    });

    app.UseRouting();

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

在上面的代码中，我们在 ConfigureServices 方法中添加了Swagger服务，并在 Configure 方法中启用Swagger UI。我们还指定了API的标题和版本号。

步骤4：运行应用程序并查看OpenAPI文档

现在，需要运行应用程序并查看OpenAPI文档。可以使用以下命令在命令行中运行应用程序：

dotnet run

在上面的命令中，使用 dotnet run 命令运行应用程序。应用程序应该已经启动了。

现在，可以在浏览器中访问以下URL来查看OpenAPI文档：

https://localhost:5001/swagger/index.html

在上面的URL中，我们使用Swagger UI查看OpenAPI文档。

示例说明

以下是两个示例说明，演示如何在ASP.NET Core中引用OpenAPI服务。

示例1：在ASP.NET Core中引用OpenAPI服务

以下是在ASP.NET Core中引用OpenAPI服务的步骤：

创建一个新的ASP.NET Core Web API项目。

dotnet new webapi -n MyWebApi

在上面的命令中，使用 dotnet new 命令创建一个新的Web API项目。使用 -n 参数指定项目的名称为 MyWebApi。

安装Swashbuckle.AspNetCore包。

使用以下命令在命令行中安装Swashbuckle.AspNetCore包：

dotnet add package Swashbuckle.AspNetCore

在上面的命令中，使用 dotnet add package 命令安装Swashbuckle.AspNetCore包。

配置Swashbuckle.AspNetCore。

在 Startup.cs 文件中添加以下代码：

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

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

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "MyWebApi", Version = "v1" });
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseSwagger();

    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyWebApi v1");
    });

    app.UseRouting();

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

在上面的代码中，我们在 ConfigureServices 方法中添加了Swagger服务，并在 Configure 方法中启用Swagger UI。我们还指定了API的标题和版本号。

运行应用程序并查看OpenAPI文档。

使用以下命令在命令行中运行应用程序：

dotnet run

在上面的命令中，使用 dotnet run 命令运行应用程序。应用程序应该已经启动了。

现在，可以在浏览器中访问以下URL来查看OpenAPI文档：

https://localhost:5001/swagger/index.html

在上面的URL中，我们使用Swagger UI查看OpenAPI文档。

示例2：在ASP.NET Core中引用多个OpenAPI服务

以下是在ASP.NET Core中引用多个OpenAPI服务的步骤：

创建两个新的ASP.NET Core Web API项目。

dotnet new webapi -n MyWebApi1
dotnet new webapi -n MyWebApi2

在上面的命令中，使用 dotnet new 命令创建两个新的Web API项目。使用 -n 参数分别指定项目的名称为 MyWebApi1 和 MyWebApi2。

安装Swashbuckle.AspNetCore包。

使用以下命令在命令行中安装Swashbuckle.AspNetCore包：

dotnet add package Swashbuckle.AspNetCore

在上面的命令中，使用 dotnet add package 命令安装Swashbuckle.AspNetCore包。

配置Swashbuckle.AspNetCore。

在 Startup.cs 文件中添加以下代码：

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

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

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "MyWebApi1", Version = "v1" });
    });

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "MyWebApi2", Version = "v1" });
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseSwagger();

    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyWebApi1 v1");
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyWebApi2 v1");
    });

    app.UseRouting();

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

在上面的代码中，我们在 ConfigureServices 方法中添加了Swagger服务，并在 Configure 方法中启用Swagger UI。我们还指定了API的标题和版本号。

运行应用程序并查看OpenAPI文档。

使用以下命令在命令行中运行应用程序：

dotnet run

在上面的命令中，使用 dotnet run 命令运行应用程序。应用程序应该已经启动了。

现在，可以在浏览器中访问以下URL来查看OpenAPI文档：

https://localhost:5001/swagger/index.html

在上面的URL中，我们使用Swagger UI查看OpenAPI文档。应该可以看到两个API的文档。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：ASP.NET Core中引用OpenAPI服务的添加示例 - Python技术站

ASP.NET Core中引用OpenAPI服务的添加示例