La OpenAPI Specification, antes conocida como Swagger Specification, es una especificación para archivos de interfaz legibles por máquina para describir, producir, consumir y visualizar servicios web RESTful. Antes formaba parte del framework Swagger; en 2016 se convirtió en un proyecto independiente, supervisado por la OpenAPI Initiative, un proyecto colaborativo de código abierto de la Linux Foundation. Swagger y otras herramientas pueden generar código, documentación y casos de prueba a partir de un archivo de interfaz.
Las aplicaciones implementadas a partir de archivos de interfaz OpenAPI pueden generar automáticamente documentación de métodos, parámetros y modelos. Esto ayuda a mantener sincronizados la documentación, las librerías de cliente y el código fuente.
Se ha lanzado un nuevo OpenAPI WebService (actualmente en BETA) que lee la OpenAPI 3.0 Specification en formato JSON y crea automáticamente un cliente Delphi en código Pascal nativo. El WebService crea una demo que muestra cómo interactuar con la API.
El WebService requiere que la especificación sea 3.0+ y esté en formato JSON.
Importar una OpenAPI Specification
El primer paso es importar la especificación openAPI 3.0; para ello usaré una sencilla especificación openAPI usada por abstractapi.com para obtener la ubicación de una dirección IP. A continuación encontrarás el archivo de especificación:
Una vez que tengas la especificación openAPI 3.0 en formato JSON, puedes generar los archivos Delphi necesarios usando nuestro OpenAPI WebService; ve a la siguiente url:
https://www.esegece.com/products/openapi/ws/demo
Solo tienes que establecer el classname (por defecto será TsgcOpenAPI_Test) y subir el archivo de especificación (¡descomprímelo primero!, debe estar en formato JSON). Por último, pulsa el botón Upload para procesar el archivo.
Si el proceso es correcto, se descargará un nuevo archivo comprimido con una demo compilada.
Probar la demo openAPI
Antes de probar la demo, debes crear una cuenta gratuita en abstractapi.com para obtener una API Key.
https://app.abstractapi.com/users/signup
Descomprime el archivo descargado y entra en la carpeta Demo; encontrarás un archivo sgcOpenAPIDemo.exe, ejecútalo.
Se muestra un nuevo formulario con la url de Abstractapi.com.
Pulsa el botón siguiente y selecciona el método Retrieve_the_location_of_an_IP_address, y rellena la Api_Key y la dirección IP a buscar. Si la petición se procesa correctamente, se devolverá un mensaje JSON con información sobre la dirección IP.
A continuación encontrarás el comprimido generado automáticamente por el sgcOpenAPI WebService para hacer las pruebas.