De OpenAPI-specificatie, voorheen bekend als de Swagger-specificatie, is een specificatie voor machine-leesbare interfacebestanden voor het beschrijven, produceren, consumeren en visualiseren van RESTful webservices. Voorheen onderdeel van het Swagger-framework, werd het in 2016 een apart project, overzien door de OpenAPI Initiative, een open-source-samenwerkingsproject van de Linux Foundation. Swagger en enkele andere tools kunnen code, documentatie en testcases genereren op basis van een interfacebestand.
Toepassingen die zijn geïmplementeerd op basis van OpenAPI-interfacebestanden kunnen automatisch documentatie van methoden, parameters en modellen genereren. Dit helpt de documentatie, client-bibliotheken en broncode synchroon te houden.
Een nieuwe OpenAPI WebService is uitgebracht (momenteel BETA) die de OpenAPI 3.0-specificatie in JSON-formaat leest en automatisch een Delphi-client in native Pascal-code creëert. De WebService maakt een demo die laat zien hoe je met de API kunt interacteren.
De WebService vereist dat de specificatie 3.0+ is en in JSON-formaat.
OpenAPI-specificatie importeren
De eerste stap is het importeren van de OpenAPI 3.0-specificatie. Hiervoor gebruik ik een eenvoudige OpenAPI-specificatie die door abstractapi.com wordt gebruikt om de locatie van een IP-adres op te halen. Hieronder vind je het specificatiebestand:
Zodra je de OpenAPI 3.0-specificatie in JSON-formaat hebt, kun je de vereiste Delphi-bestanden genereren met onze OpenAPI WebService; ga naar de volgende URL:
https://www.esegece.com/products/openapi/ws/demo
Stel gewoon de klassenaam in (standaard wordt dit TsgcOpenAPI_Test) en upload het specificatiebestand (pak het eerst uit!!!, moet in JSON-formaat zijn). Druk ten slotte op de knop Upload om het bestand te verwerken.
Als het proces succesvol is, wordt een nieuw gecomprimeerd bestand gedownload met een gecompileerde demo.
OpenAPI-demo testen
Voordat je de demo test, moet je een gratis account aanmaken op abstractapi.com om een API-sleutel te krijgen.
https://app.abstractapi.com/users/signup
Pak het gedownloade bestand uit en ga naar de map Demo; daar vind je een sgcOpenAPIDemo.exe-bestand, voer dat uit.
Er wordt een nieuw formulier getoond met de URL van Abstractapi.com.
Druk op de volgende knop en selecteer de methode Retrieve_the_location_of_an_IP_address, vul de Api_Key en het IP-adres in om te zoeken. Als het verzoek succesvol wordt verwerkt, wordt er een JSON-bericht teruggegeven met informatie over het IP-adres.
Hieronder vind je het gecomprimeerde bestand dat automatisch door de sgcOpenAPI WebService is gegenereerd om de tests uit te voeren.