A OpenAPI Specification, anteriormente conhecida como Swagger Specification, é uma especificação para arquivos de interface legíveis por máquina para descrever, produzir, consumir e visualizar serviços web RESTful. Anteriormente parte do framework Swagger, tornou-se um projeto independente em 2016, supervisionado pela OpenAPI Initiative, um projeto de colaboração open-source da Linux Foundation. Swagger e outras ferramentas podem gerar código, documentação e casos de teste a partir de um arquivo de interface.
Aplicações implementadas com base em arquivos de interface OpenAPI podem gerar automaticamente documentação de métodos, parâmetros e modelos. Isso ajuda a manter a documentação, as bibliotecas cliente e o código-fonte em sincronia.
Um novo OpenAPI WebService foi lançado (atualmente em BETA) que lê a OpenAPI 3.0 Specification em formato JSON e cria automaticamente um Cliente Delphi em Código Pascal Nativo. O WebService cria um demo que mostra como interagir com a API.
O WebService requer que a Specification seja 3.0+ e esteja em formato JSON.
Importando a OpenAPI Specification
O primeiro passo é importar a especificação openAPI 3.0. Para isso, usarei uma especificação openAPI simples utilizada pelo abstractapi.com para recuperar a localização de um endereço IP. Veja abaixo o arquivo de especificação:
Assim que você tiver a especificação openAPI 3.0 em formato JSON, pode gerar os arquivos Delphi necessários usando nosso OpenAPI WebService; acesse a seguinte url:
https://www.esegece.com/products/openapi/ws/demo
Basta definir o classname (por padrão será TsgcOpenAPI_Test) e fazer o upload do arquivo de especificação (primeiro descompacte-o!!!, deve estar em formato JSON). Por fim, pressione o botão Upload para processar o arquivo.
Se o processo for bem-sucedido, um novo arquivo compactado será baixado com um demo compilado.
Testar o Demo openAPI
Antes de testar o demo, você deve criar uma conta gratuita no abstractapi.com para obter uma API Key.
https://app.abstractapi.com/users/signup
Descompacte o arquivo baixado e vá para a pasta Demo; você encontrará um arquivo sgcOpenAPIDemo.exe, execute-o.
Um novo formulário é exibido, mostrando a url do Abstractapi.com.
Pressione o botão next e selecione o método Retrieve_the_location_of_an_IP_address; preencha a Api_Key e o Endereço IP a pesquisar. Se a requisição for processada com sucesso, uma mensagem JSON será retornada com informações sobre o endereço IP.
Veja abaixo o arquivo compactado gerado automaticamente pelo sgcOpenAPI WebService para fazer os testes.