我正在尝试使用 Swashbuckle 将 Swagger UI 集成到我的 ASP.Net MVC 项目中,但我遇到了 Swashbuckle 无法识别我的任何控制器/端点的问题。
为了简单起见,我创建了一个带有单个控制器的全新项目,如下所示:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace TestAPI.Controllers
{
public class HomeController : Controller
{
[Route("Home")]
[HttpGet]
public ActionResult Index()
{
return View();
}
[Route("Home/About")]
[HttpGet]
public ActionResult About()
{
ViewBag.Message = "Your application description page.";
return View();
}
[Route("Home/Contact")]
[HttpGet]
public ActionResult Contact()
{
ViewBag.Message = "Your contact page.";
return View();
}
}
}
我使用 Nuget 使用以下命令添加 Swashbuckle:
Install-Package Swashbuckle
我保留了整个项目以及 Swashbuckle 本身的所有默认配置(使用生成的文件 SwaggerConfig.cs)
当我导航到 Swagger 端点时,我看到的是一个空的 Swagger 定义,并且我的控制器/端点都没有显示。
我不知道如何让我的控制器/端点出现。所有 Swashbuckle 演示看起来这个基本配置至少都会显示端点。
谢谢!
编辑:以下是我的 SwaggerConfig.cs
using System.Web.Http;
using WebActivatorEx;
using TestAPI;
using Swashbuckle.Application;
[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]
namespace TestAPI
{
public class SwaggerConfig
{
public static void Register()
{
var thisAssembly = typeof(SwaggerConfig).Assembly;
GlobalConfiguration.Configuration
.EnableSwagger(c =>
{
c.SingleApiVersion("v1", "TestAPI");
})
.EnableSwaggerUi();
}
}
}
这个问题的答案是 Swashbuckle 不能与 ASP.Net MVC 一起使用。不幸的是,Swashbuckle 并不是解决这个问题的合适方法。我最终使用 Reflection 和 XML 注释的组合创建了一个自定义解决方案。
对我来说,添加 [Route] 属性就达到了目的。
EG:
// POST: Jokes/Create
// To protect from overposting attacks, enable the specific properties you want to bind to.
// For more details, see http://go.microsoft.com/fwlink/?LinkId=317598.
[HttpPost]
[ValidateAntiForgeryToken]
[Authorize]
[Route("[Controller]/[Action]")]
public async Task<IActionResult> Create([Bind("Question,Answer")] Joke joke)
{
if (ModelState.IsValid)
{
_context.Add(joke);
await _context.SaveChangesAsync();
return RedirectToAction(nameof(Index));
}
return View(joke);
}