Swagger API

Hi,

ich müßte eine API bauen und such gerade nach Lesestoff um Contao 4 mit Swagger zu verheiraten und finde irgendwie nur komplett allgemeines oder detailliertes, wo ich bereits am Anfang aussteige.

Eventuell hab ich mich auch übernommen und muß das eh als Kleinauftrag(?) ins Forum stellen.

Eigentlich müßte ich nur ein paar Formulardaten übernehmen und zu Drittanbieter mit Swagger schleusen.

Dachte ich mach das mit prepareFormData Hook, aber habe nun festgestellt, dass ich zuwenig Kenntnis von der Materie (api swagger) habe.

Weiß irgendwer ein Beispiel, wo ich mir den prinzipiellen Ablauf abgucken kann, oder doch besser Kleinauftrag ?

Ich denk, soviel Aufwand ist das eigentlich nicht, oder ?

Danke für Hinweise, Tipps

Grüße, Tintifax

wenn der Drittanbieter seine API fertig hat, sollte er Dir sagen können, wie er die Daten für einen "push" erwartet inkl. Authentifizierung usw.

in prepareFormData könntest Du z.B. mit cURL die Daten rüber schaufeln

soweit ich das bisher verstanden habe, kann ich die Formulardaten als json file übergeben
Authentifizierung erfolgt mit bearer token

Aber wie gesagt, das ist Neuland für mich, deshalb würd ich mir ja gern irgendwo ein Beispiel ansehen, finde aber nur Bruchstücke oder unpassendes

Habe aber eben festgestellt, dass mit Curl die Daten rübergeschaufelt werden sollen. Ebenfalls First Contact mit Curl.

Heißt das, ich muss eh nur die strings mit den Variablen aus dem prepareFormData Hook in folgenden Code eintragen:

PHP-Code:

---

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "firstName": "string", \ 
   "lastName": "string", \ .. 


---

Im Prinzip ja, aber anstatt direkt mit curl herumzuwurschteln würde ich dafür bspw. symfony/http-client nutzen.

PHP-Code:

---

$client->request('POST', 'https://…', [
    'json' => ['param1' => 'value1', '…'],
]); 


---

Du würdest das dann in dem Hook damit machen https://www.php.net/manual/de/book.curl.php können

hm ich glaub ich nehm das Türchen mit symfonie/http-client

das mit dem Bearer Token hab ich auch noch nicht verstanden, aber eventuell lichtet sich das, sobald ich den Api Key zum Testen hab.

Vielen Dank soweit ;)

Ich meld mich dann vermutlich morgen wieder, wenn neue Fragezeichen da sind...

Das Token schickst du so mit: https://symfony.com/doc/current/http...authentication

https://www.predic8.de/bearer-token-...i-security.htm

Zitat:

---

Zitat von zonky

https://www.predic8.de/bearer-token-...i-security.htm

---

ich mag das Keksmonster, sollte nur am Ende lächeln ;)

das lächelt doch! musst nur lange genug hin gucken

hm ich sehs nicht, in meinen Keksen fehlt wohl der Spaß ; )

ah im Video hats gelächelt am Schluß, hat aber auch 200 Kekse bekommen

Ich hab hier definitiv Wissensbedarf in OOP.

Ich kann zwar über Postman den Bearertoken erzeugen, aber wie ich das im Hook in Contao bewerkstelligen soll, verstehe ich nicht.

Ich hab einen Endpunkt zum Erhalt des Bearer Tokens, der 1h lang gültig ist und den ich mit dem Post Request abfragen muß.
Die echten Daten sind korrekt und funktionieren im Swagger Testtool.

Folgender Request erzeugt nur Error: Call to a member function request() on null

PHP-Code:

---

        $response = $client->request('POST', 'https://XXX', [
            'Headers' => [
            'Accept' => 'application/json',
            'Content-Type' => 'application/x-w w w -form-urlencoded'
            ],
            'Body' => [
            'grant_type' => 'XXX',
            'client_id' => 'XXX',
            'client_secret' => 'XXX',
            'scope' => 'XXX',
            ],
        ]); 


---

Ich geh mal davon aus, dass "use Symfony\Component\HttpClient\HttpClient;" falsch ist.

Wie bekomme ich den http-client in Contao zum Laufen ?

Der Hook selbst funktioniert.

Bitte um Hilfe

Danke

Du musst dir den Client noch erzeugen. Siehe https://symfony.com/doc/current/http...ml#basic-usage » Standalone Use, wenn du nicht Dependency Injection verwendest.

Ah vielen Dank, so komme ich weiter

headers und body mußte nur klein geschrieben werden
und 'Content-Type' => 'application/x-w w w -form-urlencoded' mußte weg

d.h. bei der Doku muß ich immer die Standalone Variante nehmen ?

Zitat:

---

Zitat von tintifax

d.h. bei der Doku muß ich immer die Standalone Variante nehmen ?

---

Nein, du kannst auch Dependency Injection benutzen ("Framework Use"):

Zitat:

---

In the Symfony framework, this class is available as the http_client service. This service will be autowired automatically when type-hinting for Symfony\Contracts\HttpClient\HttpClientInterface

---

hm ok ich muss da dringend in weiterbildung investieren

@ Spooky, hast Du keine Wunschliste mehr ?

Zitat:

---

Zitat von tintifax

@ Spooky, hast Du keine Wunschliste mehr ?

---

Nein, dafür aber Sponsoring Möglichkeit auf GitHub ;) (siehe Signatur).

Zitat:

---

Zitat von Spooky

Nein, dafür aber Sponsoring Möglichkeit auf GitHub ;) (siehe Signatur).

---

einmaliges Sponsoring gibts da nicht und einen github account braucht man auch, aber schauma mal ;)

Zitat:

---

Zitat von tintifax

einmaliges Sponsoring gibts da nicht und einen github account braucht man auch, aber schauma mal ;)

---

lass Dir eine Rechnung zusenden, wenn "Sponsoring" > 50€ netto ist

Hab hier noch eine Frage:

Also die Formulardaten und den Bearertoken kann ich nun beziehen und auch korrekt ausgeben.

Den Bearertoken übergebe ich dann einfach mit einem zusätzlichen Post Request in einem 2. HttpClient ?

PHP-Code:

---

$client2 = HttpClient::createForBaseUri('https://XXX', [
    'auth_bearer' => 'the-bearer-token',
]);
$client2->request('POST', 'https://XXX', [
    'json' => ['param1' => 'value1', '…'],
]); 


---

Zitat:

---

Zitat von zonky

"Sponsoring" > 50€ netto ist

---

definitiv

Zitat:

---

Zitat von tintifax

einmaliges Sponsoring gibts da nicht und einen github account braucht man auch, aber schauma mal ;)

---

Gleich daneben gibt's auch einen PayPal Link für einmalige Spenden.

Zitat:

---

Zitat von tintifax

Hab hier noch eine Frage:

Also die Formulardaten und den Bearertoken kann ich nun beziehen und auch korrekt ausgeben.

Den Bearertoken übergebe ich dann einfach mit einem zusätzlichen Post Request in einem 2. HttpClient ?

PHP-Code:

---

$client2 = HttpClient::createForBaseUri('https://XXX', [
    'auth_bearer' => 'the-bearer-token',
]);
$client2->request('POST', 'https://XXX', [
    'json' => ['param1' => 'value1', '…'],
]); 


---

---

Kann auch der selbe Client sein, die auth_bearer Option musst du nicht unbedingt beim erzeugen des Clients setzen, sondern kannst sie bei jedem Request mitgeben.

hm irgendwie funzt das noch nicht

ich müßte doch einen zweiten Client brauchen

Den Token hole ich mir von https: XXX

Und die Daten muß ich auf https: YYY schicken

Das muß ich doch in 2 requests machen, oder nicht ?

Scheinbar übergebe ich den Token falsch, bekomme 403 Error

So funktioniert das wohl nicht:

PHP-Code:

---

$clientBearer = HttpClient::create();

        $response = $clientBearer->request('POST', 'https://XXX', [
            'headers' => [
            'Accept' => 'application/json',
            ],
            'body' => [
            'client_secret' => 'zzzz',
            ],
        ]); 

$contentBearer = $response->toArray();    
$bearertoken = $contentBearer['access_token'];

    $client = HttpClient::create();            
        $client->request('POST', 'https://YYY', [
            'auth_bearer' => 'Bearer' . $bearertoken,
            'json' => [    
            'email'=> $email,
            ],
            ]); 


---

Dann fiel mir aber auf, dass ich den Token mit einem Leerzeichen übergeben muß:
Also 'auth_bearer' => 'Bearer ' . $bearertoken,

Damit bekomm ich aber diesen Error: "Invalid character found in option "auth_bearer":

Was ist falsch bzw was ist bereits richtig ?

Zwei Clients brauchst du wie gesagt nicht unbedingt.

Zitat:

---

Zitat von tintifax

Dann fiel mir aber auf, dass ich den Token mit einem Leerzeichen übergeben muß:
Also 'auth_bearer' => 'Bearer ' . $bearertoken,

Damit bekomm ich aber diesen Error: "Invalid character found in option "auth_bearer":

Was ist falsch bzw was ist bereits richtig ?

---

Den Bearer Header setzt du gar nicht selbst. Du schreibst einfach nur

PHP-Code:

---

[
    'auth_bearer' => $token,
] 


---

Siehe https://symfony.com/doc/current/http...authentication

hm komm nicht weiter

hab aber das beim googeln gefunden: https://github.com/symfony/symfony/pull/38647

kann das damit etwas zu tun haben ?
scheinbar ja, wie ich glaube, aber das ist nur Raten auf niedrigem Niveau

zumindest hat es etwas mit Traits zu tun. In der Erromeldung betrifft es die ResponseTrait.php:

PHP-Code:

---

../vendor/symfony/http-client/Response/ResponseTrait.php:291 


---

Wo kommst du nicht weiter, bzw. was genau ist das Problem?

ich weiß nicht wie ich den Token übergeben soll

der muss in der Form "Bearer 1234" übergeben werden

beim ersten Request bekomm ich den Token aber nur als "1234"

Zitat:

---

Zitat von tintifax

der muss in der Form "Bearer 1234" übergeben werden

---

Nein, siehe mein voriger Post. Du übergibst nur den Token, den Bearer Header setzt der Symfony HTTP Client selbst.

omg jetzt hats funktioniert ;)

ich hab die Variablen der zu übergebenen Daten zwischendurch auskommentiert und deshalb einen 500er bekommen

so gehts nun:

PHP-Code:

---


$clientBearer = HttpClient::create();

        $response = $clientBearer->request('POST', 'https://XXX', [
            'headers' => [
            'Accept' => 'application/json',
            ],
            'body' => [
            'client_secret' => 'zzzz',
            ],
        ]); 

$contentBearer = $response->toArray();    
$bearertoken = $contentBearer['access_token'];

$client2 = HttpClient::createForBaseUri('https://YYY', [
        'auth_bearer' => $bearertoken,
        ]);
    
$response2 = $client2->request('POST', 'https://YYY', [
        'json' => [    
        'email'=> $email,
        ],
        ]); 


---

jetzt noch Feinschliff was noch alles übergeben werden muß und dann bin ich fertig.
Danach werd ich dann mal mein PayPal bemühen.

Interesse halber, weil Du - Spooky - meintest, ich kanns in 1 Request machen:

In 1 Request bekomm ich das doch nicht hin, oder doch irgendwie ?

Ich hab ja 2 URLS

Wegen Dublettenprüfung muß ich hier eh auch noch einen dritten Request einschieben.

PHP-Code:

---

$client = HttpClient::create();

$token = $client ->request('POST', 'https://XXX', [
        'headers' => [
            'Accept' => 'application/json',
        ],
        'body' => [
            'client_secret' => $secret,
        ],
    ])
    ->toArray()['access_token']
;

$response = $client->request('POST', 'https://YYY', [
        'auth_bearer' => $token,
        'json' => [    
            'email'=> $email,
        ],
    ])
; 


---

ja definitiv eleganter ;)

PHP-Code:

---

$client = HttpClient::create();

$token = $client->request('POST', 'https://XXX', [
        'headers' => [
            'Accept' => 'application/json',
        ],
        'body' => [
            'client_secret' => $secret,
        ],
    ])
    ->toArray()['access_token']
;

$response = $client->request('POST', 'https://YYY', [
        'auth_bearer' => $token,
        'json' => [    
            'email'=> $email,
        ],
    ])
; 


---

so - oder?

ja das hab ich auch grad entdeckt
Fehlerteufelchen schläft auch bei Spooky nicht
Hat Spooky selber schon ausgebessert

Zitat:

---

Zitat von Spooky

Gleich daneben gibt's auch einen PayPal Link für einmalige Spenden.

---

Bist Dir sicher ? Wo ist der ? Den seh ich nicht, hab sogar eingeloggt, gibts ja nicht...

da https://easycaptures.com/fs/uploaded...1310709414.png

Zitat:

---

Zitat von zonky

da https://easycaptures.com/fs/uploaded...1310709414.png

---

ach hier im forum hab in github gesucht
aber seltsamerweise seh ich diese Zeile hier nicht

dann für Dich "auf die harte Tour": https://paypal.me/fritzmg

;-)