Client-Units für JSON-REST-Services erzeugen

[Zwixx]

Bei mir ist es ähnlich. Ich muss auch nachfragen oder mache es privat "nochmal". Es funktionieren diverse Dinge auch schon, wie das erzeugen der Objekte, die Rümpfe der Methoden. Bei mir geht es jetzt daran, eine schöne Implementierung für die Methoden zu finden und auch solche Dinge wie Authentifizierung zu unterstützen (wahrscheinlich per event).

[HeZa]

Hallo Zwixx,

Zitat von Zwixx:

Es funktionieren diverse Dinge auch schon, wie das erzeugen der Objekte, die Rümpfe der Methoden. Bei mir geht es jetzt daran, eine schöne Implementierung für die Methoden zu finden und auch solche Dinge wie Authentifizierung zu unterstützen (wahrscheinlich per event).

Schreibst du jetzt eine Erweiterung für https://github.com/OpenAPITools/openapi-generator in Java oder ein standalone Delphi-Programm, das die OpenAPI-Spezifikation in JSON oder YAML liest?

Ciao HeZa

[Zwixx]

Bei mir ist es eine Erweiterung des openapi-generator

[Zwixx]

So, ich habe mich dazu entschieden das ganze (privat) nochmal zu machen. Dabei habe ich auch gleich einige Fehler im Design behoben.

Als Beispiel für eine OpenAPI-Datei habe ich einfach einmal die API von ebay ausgesucht, da sie mir am ausreichend komplex erschien.

https://developer.ebay.com/api-docs/...ources/methods

Der Sourcecode den es bisher erzeugt ist fast Syntaxmäßig valide (was aber nicht heisst, das es funktioniert ), bis auf eine Methode (getSalesTax). Sie wird offenbar gleichzeitig als POST und als GET verwendet. So eine Konstruktion ist nicht schön, aber durchaus valide. Deswegen muss ich mir da etwas einfallen lassen, wie ich solche Doppeldeutigkeiten auflöse.

Quellcode auf Github: https://github.com/Zwixx/delphi-openapi-generator

Eine Beispieldatei was dabei heraus kommt wenn ich das erzeuge habe ich angehängt.

[Rollo62]

Danke dafür, ist sehr interessant

[TiGü]

Zitat von Zwixx:

Der Sourcecode den es bisher erzeugt ist fast Syntaxmäßig valide (was aber nicht heisst, das es funktioniert ), bis auf eine Methode (getSalesTax). Sie wird offenbar gleichzeitig als POST und als GET verwendet. So eine Konstruktion ist nicht schön, aber durchaus valide. Deswegen muss ich mir da etwas einfallen lassen, wie ich solche Doppeldeutigkeiten auflöse.

Sehr cool!

Warum hast du dich entschieden, für jeden Aufruf jeweils eine neue Instanz von TRESTRequest, TRestClient und TRESTResponse zu verwenden?
Gab es dafür gewichtige Gründe?
Instinktiv hätte ich den Request als Klassenvariable angelegt und vor jeden Ausführen geresetet.

[Zwixx]

Zitat von TiGü:

Warum hast du dich entschieden, für jeden Aufruf jeweils eine neue Instanz von TRESTRequest, TRestClient und TRESTResponse zu verwenden?
Gab es dafür gewichtige Gründe?
Instinktiv hätte ich den Request als Klassenvariable angelegt und vor jeden Ausführen geresetet.

Wie gesagt, der Quettext mag syntaktisch richtig sein, schön ist er nicht. Das ist beispielsweise einer der Punkte, die man noch besser machen sollte.

Folgende Fehler habe ich heute noch behoben:

Arrays werden jetzt korrekt beachtet
Request wird nur einmal erstellt und immer wieder verwendet.
Fehler mit ToString bei Strings behoben

Das Problem mit dem getSalesTax existiert immer noch. Das sehe ich mir mal als nächstes die Tage an.

[TiGü]

Zitat von Zwixx:

Das Problem mit dem getSalesTax existiert immer noch. Das sehe ich mir mal als nächstes die Tage an.

Fällt das so aus dem OpenAPI-Generator raus?
Weil in der HTML-Doku steht dazu ja nichts (oder ich sehe es nicht, weil der Kaffee noch nicht wirkt).
https://developer.ebay.com/api-docs/...ds/getSalesTax

[Zwixx]

Zitat von TiGü:

Fällt das so aus dem OpenAPI-Generator raus?
Weil in der HTML-Doku steht dazu ja nichts (oder ich sehe es nicht, weil der Kaffee noch nicht wirkt).
https://developer.ebay.com/api-docs/...ds/getSalesTax

Ja, irgendwas ist allerdings an dieser Funktion komisch. Da nur gerade diese nicht funktioniert. Aber das bekomme ich schon noch raus was da schief läuft.

Danach werde ich das ganze mal testen ob es überhaupt funktioniert, wenn das klappt dann könnte ich mal die erste alpha releasen.

Ich weis noch nicht, wie ich mit Authentifizierung umgehe. Ich habe ja überall die "vor" und "danach" Methoden eingebaut, so dass jeder seine eigenen Methoden zur Authentifizierung machen kann. Oder ich sehe ein paar einfache Dinge vor, wie Basic Auth und OAuth2 beispielsweise. Das wenn diese Zugriffsmethoden im openapi erwähnt werden, das man so eine Art Supportmethoden bekommt, die einem helfen das zu implementieren.

[Zwixx]

Ich habe es heruasgefunden woran es liegt. Es wird im openapi.yaml mit folgenden response beschrieben:

Code:

        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesTax"
                }
              }
            }
          },
          "204": {
            "description": "No content"
          },

Ich gehe davon aus, das man wenn keine response vorhanden ist, es eine procedure ist, wenn es einen Rückgabewert gibt, eine function ist. In diesem Falle wird sie aber als beides beschrieben. Sie kann einmal ein Objekt zurückgeben, einmal nicht.

Was macht das für einen Sinn?

Ich werde sehen, wie ich das behandeln kann.