当本地人为swagger.json提供服务时,Autorest无法针对文件解析swagger.json

时间:2020-03-26 04:26:23

标签: c# asp.net-core openapi swashbuckle autorest

当swagger.json托管在网站上时,我能够使用Autorest_core 3生成客户端,但是当托管在localhost上时,我不能使用该客户端。

但是,如果我将本地主机中的swagger.json剪切并粘贴到文件中,则可以生成客户端。

在startup.ConfigureServices中,我拥有

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

            c.CustomOperationIds(  d => (d.ActionDescriptor as ControllerActionDescriptor)?.ActionName);

然后在Startup.Configure我有

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

        app.UseHttpsRedirection();

        // Enable middleware to serve generated Swagger as a JSON endpoint.
        app.UseSwagger();
        app.UseSwagger(c =>
        {
            c.RouteTemplate =
                "api-docs/{documentName}/swagger.json";
        });

        // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
        // specifying the Swagger JSON endpoint.
        app.UseSwaggerUI(c =>
        {
            c.SwaggerEndpoint("./v1/swagger.json", "My API V1");
        });

        app.UseRouting();

        app.UseAuthorization();

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

当我启动api并尝试生成客户端

autorest --v3 --input-file=localhost:44338/swagger/v1/swagger.json --csharp --output-folder=generated --namespace=Connector

我得到以下输出

https://aka.ms/autorest
   Loading AutoRest core      'C:\Users\kirst\.autorest\@autorest_core@3.0.6262\node_modules\@autorest\core\dist' (3.0.6262)
   Loading AutoRest extension '@microsoft.azure/autorest.csharp' (~2.3.79->2.3.84)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.55->2.3.55)
  Error: Failed resolving 'localhost:44338/swagger/v1/swagger.json' against 'file:///D:/Users/kirst/source/repos/Dogs/'

但是以下方法确实有效

autorest --v3 --input-file=D:\Users\kirst\source\repos\Dogs\src\swagger.json --csharp --output-folder=generated --namespace=Connector

[编辑笔记]

正如我早些时候以为我的问题可能与我使用的哪个版本的autorest有关,我已经对该问题进行了广泛的编辑。我实际上不清楚是否可以使用autorest v2从localhost swagger.json生成

我只是发现,如果我将swagger.json剪切并粘贴到文件中,便可以从本地主机生成文件。我希望不必这样做。

可悲的是,输出的https://aka.ms/autorest给出了404

[更新]

我尝试使用http前缀

Error: Could not read 'http://localhost:44338/swagger/v1/swagger.json'

类似于https

如果我浏览到http://localhost:44338/swagger/v1/swagger.json,则会收到错误消息

This site can't be reached 

如果我浏览到https://localhost:44338/swagger/v1/swagger.json,它将重定向到localhost:44338 / swagger / v1 / swagger.json

我尝试按以下方式更改“配置”,但这没什么作用

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

在项目调试标签中,我有

app url

[更新]

我未选中ssl并成功运行了以下内容。

autorest --v3 --input-file=http://localhost:60705/swagger/v1/swagger.json --csharp --output-folder=generated --namespace=Connector

如果我点击该网址, an insecure url message

1 个答案:

答案 0 :(得分:2)

http添加到--input-file后,该问题为我解决了:

autorest --v3 --input-file=http://localhost:5000/swagger/v1/swagger.json --csharp

更新

就HTTPs / TLS而言,如果正确配置了HTTPs / TLS以及证书来自受信任的CA,自动停止将自动工作。

如果使用自签名证书进行开发,则需要额外的步骤以允许在NodeJS中使用自签名证书:

  1. 已安装且受信任的开发证书
  2. NODE_TLS_REJECT_UNAUTHORIZED系统变量设置为0
  3. 关闭并重新启动所有控制台