Ab sgcOpenAPI 2024.9.0 wurde der Parser um folgende Neuerungen erweitert:
- Bundle Specification: Wenn die Spezifikation aus mehreren Schemas besteht, kann der Parser sie zu einer einzelnen Spezifikationsdatei bündeln.
- Output Parser Parameters: Beim Erstellen der Pascal-Schnittstelle werden die zum Import der Spezifikationen verwendeten Parameter in den Header der Pascal-Datei geschrieben.
- Ein neues Ereignis wurde für den sgcOpenAPI-Client erstellt, OnBeforeRequest, mit dem du die HTTP-Anfrage anpassen kannst, bevor sie an den Server gesendet wird.
Bundle Specification
Wenn OpenAPI- oder JSON-Schema-Dokumente sehr groß oder repetitiv werden, lassen sich die Inhalte auf mehrere Dokumente verteilen (im Dateisystem, an URLs, irgendwo im Speicher) und über $ref miteinander verknüpfen. Diese aufgeteilten API-Beschreibungen können dann wieder zu einem einzigen Dokument zusammengefügt werden, wobei $ref auf eine interne statt auf eine externe Stelle zeigt. Das nennt man "Bundling".
Der sgcOpenAPI-Parser unterstützt jetzt das Bündeln von OpenAPI-Spezifikationen. Das geschieht automatisch beim Importieren einer Datei.
Aufgeteilte OpenAPI-Spezifikation
openapi: 3.0.0
info:
title: My API
version: 1.0.0
paths:
/things:
get:
responses:
'200':
description: 'OK'
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: './schemas/thing.yaml'
/things/{id}:
get:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 'OK'
content:
application/json:
schema:
$ref: './schemas/thing.yaml'
Gebündelte Spezifikation
openapi: 3.0.0
info:
title: My API
version: 1.0.0
paths:
/things:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/paths/~1things~1%7Bid%7D/get/responses/200/content/application~1json/schema'
'/things/{id}':
get:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
enum:
- type1
- type2
Output Parser Parameters
Die aus der OpenAPI-Spezifikation erzeugte Pascal-Datei enthält jetzt die zum Import der OpenAPI-Datei verwendeten Parameter. Diese Parameter werden als Kommentare am Anfang der Delphi-Datei erzeugt.
{ ***************************************************************************
sgcOpenAPI component
written by eSeGeCe
copyright © 2024
Email : info@esegece.com
Web : http://www.esegece.com
Source: D:\Downloads\ICAR-ADE-1\url-schemes\registrationURLScheme.json
Parsed At: 2024-10-02 10:12:18
Options: [Generate Classes] [Enable Classes] [Documentation]
Authentication: Token
Method Name: OperationId
Base URL: https://spec.openapi.com
*************************************************************************** }
OnBeforeRequest-Ereignis
Dieses Ereignis wird aufgerufen, bevor die HTTP-Anfrage abgesetzt wird. Damit kannst du Parameternamen, Header, Security usw. anpassen. Unten findest du ein Beispiel, wie du den Namen einiger Parameter ersetzt.
procedure OnBeforeRequestEvent(Sender: TObject; const aRequest: TsgcOpenAPIRequest);
var
i: Integer;
oParameter: TsgcOpenAPIParameter;
begin
for i := 0 to aRequest.Parameters.Count - 1 do
begin
oParameter := aRequest.Parameters[i];
if oParameter._Name = 'meta-modified-from' then
oParameter._name := 'eventDateTime-from';
if oParameter._Name = 'meta-modified-to' then
oParameter._name := 'eventDateTime-to';
end;
end;