swagger.json 路径和定义为空。 规范中没有定义操作

Question

我正在开发一个 .netcore Web 应用程序。 我正在使用 swagger 并进行了所有必要的调整。 不幸的是它不起作用，我只看到No operations defined in spec! 在 swagger 输出页面中。

带有/swagger/v1/swagger.json的 swagger 文件具有以下内容：

{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "Something"
  },
  "paths": {},
  "definitions": {}
}

我想在 swagger 输出页面中查看我的控制器及其操作。

Answer 1

经过一番研究，我发现我的问题是关于在.NetCore2.1中将swagger与OData一起使用。 我找到了解决这个问题的方法。

首先，我添加了以下两个Nuget软件包：

Swashbuckle.AspNetCore
Swashbuckle.AspNetCore.Annotations

然后，我在Startup.cs中添加了以下代码

services.AddMvc(options => {
                foreach (var outputFormatter in 
options.OutputFormatters.OfType<ODataOutputFormatter>().Where(_ => 
_.SupportedMediaTypes.Count == 0))
                {
                    outputFormatter.SupportedMediaTypes.Add(new 
MediaTypeHeaderValue("application/prs.odatatestxx-odata"));
                }
                foreach (var inputFormatter in 
options.InputFormatters.OfType<ODataInputFormatter>().Where(_ => 
_.SupportedMediaTypes.Count == 0))
                {
                    inputFormatter.SupportedMediaTypes.Add(new 
MediaTypeHeaderValue("application/prs.odatatestxx-odata"));
                }
            }).SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

的，我在控制器中添加了以下代码行：

[ApiExplorerSettings(IgnoreApi = false)] 

请注意，它对我有用，但可能需要更多研究以最终发现副作用

Answer 2

请在控制器中添加任何方法，例如然后显示 swagger 方法

  [HttpGet]
    [EnableQuery]
    public IQueryable<int> Get()
    {
        return 1;
    }

Answer 3

听起来您需要在控制器中添加一些路由。 对于休息服务，您需要将它们与 Visual Studio 自动构建的内容分开添加。 例如 // GET: Items [HttpGet] [Route("/items")] ...其余的功能...这会给你的招摇参考当你点击按钮时它会做什么。

Answer 4

您需要在project obtions => Build选项卡下启用XML Documentation file 。

然后，您需要通过swagger读取此文件，以便swagger可以从中创建文档。

private static string[] XmlCommentsFilePath
{
    get
    {
        var basePath = PlatformServices.Default.Application.ApplicationBasePath;

        var apiDocFile = typeof(Startup).GetTypeInfo().Assembly.GetName().Name + ".xml";
        var apiPath = Path.Combine(basePath, apiDocFile);

        return new[] {apiPath};

    }
}

在ConfigureServices中

services.AddSwaggerGen(options =>
{ 
    var provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();

    // add a swagger document for each discovered API version
    provider.ApiVersionDescriptions.ForEach(x => options.SwaggerDoc(x.GroupName, CreateInfoForApiVersion(x)));

    ....
});