在.NET核心中按项目分组Swagger

Question

我正在做一个我命名为“主项目”的项目。我至少有10个不同的小项目在那里，这个项目可能会增长。我对所有这些项目只有一个自信，因为所有这些项目都只使用一个dotnet核心web应用程序来进行推广。

例如，假设我有一个名为schooljob的项目和一个名为hospitaljob的项目。SchoolJob有三个不同的endpoint，分别名为GetStudents、TakeStudents、GetPayments、HostPitalJob和GetDoctors。这两个不同的项目将出现在一个大摇大摆的UI中，如下所示：

 - ../schooljob/getstudents
 - ../schooljob/takestudents 
 - ../schooljob/getpayment
 - ../hospitaljob/getdoctors
 - ../hospitaljob/getnurses

我想做的是在一个dotnet核心web项目中设置多个不同的大摇大摆的页面，或者将一个大摇大摆的页面分组，这样它们就可以在不同的页面/或者在同一页面上看到，但不是在同一时间。

../mainProject/swagger1/index.html或mainProject/swagger/schooljob UI应该如下所示：

 - ../schooljob/getstudents
 - ../schooljob/takestudents 
 - ../schooljob/getpayment

../mainproject/swagger2/index.html或mainproject/swagger/hospitaljob UI应该是这样的

 - ../hospitaljob/getdoctors
 - ../hospitaljob/getnurses

// Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    c.SwaggerDoc("schooljob", new OpenApiInfo
    {
        Version = "schooljob",
        Title = "School Job"
    });
    c.SwaggerDoc("hospitaljob", new OpenApiInfo
    {
        Version = "hospitaljob",
        Title = "Hospital Job"
    });
    // c.AddSecurityDefinition... and other swagger configurations
}   
public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IServiceProvider serviceProvider)
{
    app.UseSwagger(c =>
    {
        c.RouteTemplate = "mainproject/swagger/{documentname}/swagger.json";
    });
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/mainproject/swagger/schooljob/swagger.json", "School Job");
        c.SwaggerEndpoint("/mainproject/swagger/hospitaljob/swagger.json", "Hospital Job");
        c.RoutePrefix = "mainproject/swagger";
        /c second prefix how?
    });
}

// SchoolController.cs

[HttpPost("schooljob/getstudents")]
[ApiExplorerSettings(GroupName = "schooljob")]
public JsonResult GetStudents([FromBody]OnaySayfasiId onaySayfasi)
{ ... }

// HospitalController.cs

[HttpPost("hospitaljob/getdoctors")]
[ApiExplorerSettings(GroupName = "hospitaljob")]
public JsonResult GetDoctors([FromBody]OnaySayfasiId onaySayfasi)
{ ... }

顺便说一下，我尝试使用按Api版本分组，但我再次看到了所有这些endpoint。有什么方法可以做到这一点吗？

Answer 1

我知道您遗漏了什么，您使用了错误的控制器属性，下面是您可以做的：

• 在控制器中，必须使用[ApiVersion]而不是[apiExplorerSettings(GroupName=...)]属性。组是不同的，我想它们是关于在Swagger页面中将endpoint分组在同一节下。
• 当方法参数需要版本时，要保持一致。openapiinfo、swaggendpoint、apiversion需要相同的字符串，例如schooljob，而不是schooljob.

我想如果您按以下方式更新代码，它应该会起作用：

// Startup.cs

app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/mainproject/swagger/schooljob/swagger.json", "schooljob");
        c.SwaggerEndpoint("/mainproject/swagger/hospitaljob/swagger.json", "hospitaljob");
        c.RoutePrefix = "mainproject/swagger";
        // No need for 2nd route prefix as there is only one Swagger page,
        // the content of the page gets updated when selecting a different version in the combobox.
    });

/* This line may be required in ConfigureServices method, give it a try */
/* services.AddApiVersioning(); */

// SchoolController.cs

[HttpPost("schooljob/getstudents")]
[ApiVersion("schooljob")]
public JsonResult GetStudents([FromBody]OnaySayfasiId onaySayfasi)
{ ... }