[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twice
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 77/100
- Issue-Typ
- Bug
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Bereich
- backend-api-design
Rechercherichtung
Das Issue nennt Configuration#configure_faraday und Connection#deserialize als Parsing-Pfad. Lies zunächst diese Methoden im Ruby-Nextgen-Generator und seinen generierten Client-Vorlagen. Füge einen Regressionstest für eine JSON-String-Antwort wie "hello" hinzu oder suche einen solchen Test, und führe anschließend die relevanten Ruby-Nextgen-Client-Tests aus. Erledigt ist die Aufgabe, wenn die Antwort den String erfolgreich zurückgibt, ohne ApiError auszulösen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
Description
Configuration#configure_faraday registers the :json response middleware, which decodes a JSON response body. Connection#deserialize then calls JSON.parse again on any body that is still a String. A response whose JSON value is a string ("hello") is decoded to hello by the middleware, the second parse fails, and a successful call raises ApiError.
openapi-generator version
master, 7.28.0-SNAPSHOT, 8a9fb722777e770e2c44b20b00bddbb51a0d525a
OpenAPI declaration file content or url
openapi: 3.0.3
info:
title: probes
version: 1.0.0
paths:
/greeting:
get:
operationId: getGreeting
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
/pets:
get:
operationId: listPets
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
components:
schemas:
Pet:
type: object
properties:
birthday:
type: string
format: date
code:
type: string
pattern: '^[a-z]+$'
Generation Details
java -jar openapi-generator-cli.jar generate -g ruby-nextgen -i spec.yaml -o out \
--additional-properties=gemName=petstore,moduleName=Petstore
Steps to reproduce
$LOAD_PATH.unshift 'out/lib'
require 'petstore'
# Replies to every request with a fixed JSON body.
class Reply < Faraday::Middleware
def initialize(app, body)
super(app)
@body = body
end
def call(env)
env.status = 200
env.body = @body
env.response_headers = Faraday::Utils::Headers.new('Content-Type' => 'application/json')
env.response = Faraday::Response.new(env)
end
end
client = Petstore::Client.new(base_url: 'http://localhost') { |c| c.use(Reply, '"hello"') }
begin
p client.greeting.list.data
rescue Petstore::ApiError => e
puts "#{e.class}: #{e.message}"
end
Actual (ruby 4.0.9, faraday 2.15.1):
Petstore::ApiError: invalid JSON in response body: unexpected character: 'hello' at line 1 column 1
Expected:
"hello"
Related issues/PRs
Raised by the automated review of #25717; the code is already on master and is not changed by that PR.
- Vorherrschende Sprache
- Java
- Sterne
- 26.9k
- Forks
- 7.8k
- Ø Merge
- 2 T. 23 Min.
- Gemergte PRs (30 T.)
- 177
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus OpenAPITools/openapi-generator
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Enhancement: Feature
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorEvtl. vergeben @Inf1mum hat das vor 2 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
OpenAPITools/openapi-generator#25724 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayEvtl. vergeben @Inf1mum hat das vor 2 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
OpenAPITools/openapi-generator#25723 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG][JAVA] Deprecated properties only get @Deprecated on the getter (base, feign, native, microprofile)Evtl. vergeben @Inf1mum hat das vor 11 Tagen übernommen. OffenIssue: Bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
OpenAPITools/openapi-generator#25567 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in OpenAPITools/openapi-generator
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
eclipse-tradista/tradista#371 ·
Maintainer antworten meist innerhalb von 1 Tag
-
critical
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
mars-sim/mars-sim#2199 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
primefaces/primefaces#15568 ·
Maintainer antworten meist innerhalb von 1 Tag
-
崩溃日志只按 CRLF 分行Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
PCL-Community/PCL-CE#3872 ·
Maintainer antworten meist innerhalb von 1 Tag