Geração de Código

Com base na especificação da API, o Apidog suporta a geração automática de código de negócio para várias linguagens e frameworks, incluindo, entre outros, TypeScript, Java, Go, Swift, Objective-C, Kotlin, Dart, C++, C#, Rust e mais de 130 outras linguagens e frameworks.

O Apidog disponibiliza três tipos de Geração de Código: Gerar Server Stubs e SDKs de Cliente, Gerar Código de Cliente e Gerar Código de Modelo de Dados.

Gerar Server Stubs e SDKs de Cliente: Os Server Stubs destinam-se a programadores de API, enquanto os SDKs de Cliente se destinam a consumidores de API. Isto produz código tanto do lado do servidor como do lado do cliente. Os server stubs são implementações esqueléticas de endpoints de API no servidor, enquanto os SDKs de Cliente são bibliotecas pré-criadas para diferentes linguagens de programação interagirem com a API.

Gerar Código de Cliente: Para consumidores de API. Cria código para aplicações cliente interagirem com uma API.

Gerar Código de Modelo de Dados: Para consumidores de API. Gera representações em código das estruturas de dados utilizadas na API. Isto inclui classes ou structs que definem a forma dos objetos de pedido e resposta, ajudando a garantir a segurança de tipos e a consistência em toda a aplicação.

Gerar Server Stubs e SDKs de Cliente

A funcionalidade Gerar Server Stubs e SDKs de Cliente no Apidog permite aos programadores simplificar o processo de implementação de APIs, gerando automaticamente stubs de código do lado do servidor e SDKs do lado do cliente com base nas especificações de API definidas na plataforma.

Os Server Stubs são modelos de código que podem ser utilizados para iniciar aplicações do lado do servidor, fornecendo uma base para implementar os endpoints de API especificados, o tratamento de pedidos e a geração de respostas. Por outro lado, os SDKs de Cliente oferecem snippets de código pré-configurados para interagir com a API a partir do lado do cliente, simplificando a integração da funcionalidade da API em várias aplicações.

Como Gerar

1. Instalar o plugin de geração de código

Clique em Gerar Código na especificação da API e selecione Gerar Server Stubs e SDKs de Cliente.

Clique no botão Transferir e Instalar na página de geração de código de negócio.

NOTE

Se a sua rede não conseguir aceder à internet, transfira manualmente openapi-generator-cli-7.13.0.jar a partir de:
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

Em seguida, coloque o ficheiro JAR no seguinte diretório do seu sistema:

macOS: ~/Library/Application Support/apidog/

Windows: C:\Users\<USERNAME>\AppData\Roaming\apidog\

Linux: ~/.config/apidog/

O plugin irá detetar e utilizar automaticamente o JAR local, pelo que não é necessária ligação à internet.

2. Gerar código

Selecione o código de servidor ou cliente pretendido e clique em Gerar Código.

3. Utilizar modelo personalizado

Também pode utilizar a funcionalidade Modelos de Código Personalizados para gerar código que esteja em conformidade com as especificações arquitetónicas da sua equipa e responda a uma variedade de necessidades individuais.

Linguagens/Frameworks Suportados

Linguagem	Servidor/Cliente	Frameworks
Java	Servidor	Spring, Inflector, Msf4j, Pkmst, Play Framework, Undertow Server, Vertx, Vertx Web, JAX-RS Cxf, JAX-RS Cxf Cdi, JAX-RS Cxf Extended, JAX-RS Jersey, JAX-RS Resteasy, JAX-RS Resteasy Eap, JAX-RS Spec
Java	Cliente	Android, Java
PHP	Servidor	Laravel, Lumen, Symfony, Ze Ph, Slim4, Slim (Obsoleto), Silex (Obsoleto)
PHP	Cliente	PHP
Swift	Cliente	Swift5, Swift4, Swift3 (Obsoleto), Swift2 (Obsoleto)
Kotlin	Servidor	Kotlin Server, Kotlin Spring, Kotlin Vertx
Kotlin	Cliente	Kotlin
JavaScript	Cliente	Apollo, Flowtyped, Closure Angular
Node.js	Servidor	Express, GraphQL Express
TypeScript	Cliente	Axios, Fetch, Redux Query, Angular, Angularjs, Jquery, Rxjs, Node, Aurelia, Inversify
C++	Servidor	Pistache Server, Qt5 Qhttpengine Server, Restbed Server
C++	Cliente	Qt5 Client, Restsdk, Tizen
C#	Servidor	C# Nancyfx
C#	Cliente	C#, C# Netcore, C# Dotnet2
ASP.NET	Servidor	ASP.NET Core
Dart	Cliente	Dart, Dart Dio, Dart Jaguar
Go	Servidor	Go Server, Go Gin Server
Go	Cliente	Go, Go (Experimental)
C	Cliente	C
Objective-C	Cliente	Objective-C
Scala	Servidor	Scala Akka Http Server, Scala Finch, Scala Lagom Server, Scala Play Server
Scala	Cliente	Scala Akka, Scala Gatling, Scala Sttp, Scalaz, Scala Httpclient (Obsoleto)
Clojure	Cliente	Clojure
Groovy	Cliente	Groovy
Python	Servidor	Python Aiohttp, Python Blueplanet, Python Flask
Python	Cliente	Python, Python (Experimental)
Rust	Servidor	Rust Server
Rust	Cliente	Rust
Ruby	Servidor	Ruby On Rails, Ruby Sinatra
Ruby	Cliente	Ruby
R	Cliente	R
Perl	Cliente	Perl
PowerShell	Cliente	PowerShell
JMeter	Cliente	JMeter
Bash	Cliente	Bash
Lua	Cliente	Lua
F#	Servidor	F# Functions, F# Giraffe Server
OCaml	Cliente	OCaml
Erlang	Servidor	Erlang Server
Erlang	Cliente	Erlang Client, Erlang Proper
Flash	Cliente	Flash
Elixir	Cliente	Elixir
Haskell	Servidor	Haskell
Haskell	Cliente	Haskell Http Client
Elm	Cliente	Elm
Nim	Cliente	Nim
Ada	Servidor	Ada Server
Ada	Cliente	Ada
Apex	Cliente	Apex
Eiffel	Cliente	Eiffel

TIP

As funcionalidades dos modelos de código do Apidog baseiam-se no OpenAPI Generator, mas são simplificadas. Pode consultar este Youtube Video para saber mais sobre as regras dos modelos do OpenAPI generator.

Gerar Código de Cliente

O código de cliente é utilizado para iniciar pedidos de API em vários ambientes de desenvolvimento. Clique no botão Gerar Código de Cliente no lado direito do separador Documentação na API.

Também pode gerar código clicando no ícone de código </> no separador Executar na API.

NOTE

O código de Cliente gerado através dos métodos mencionados incluirá APENAS as especificações da API e NÃO os valores dos parâmetros do pedido. Se pretender gerar código de Cliente que inclua os valores dos parâmetros do pedido, tem de enviar primeiro o pedido e, em seguida, mudar para o separador Pedido Real. Desloque-se para baixo para encontrar o código de Cliente que inclui os valores dos parâmetros.

Linguagens Suportadas

Linguagem	Variante
Shell	cURL, cURL-Windows, Httpie, wget, PowerShell
JavaScript	Fetch, Axios, jQuery, XHR, Native, Request , Unirest
Java	Unirest, OkHttp
Swift	URLSession
Go	Native
PHP	cURL, Guzzle, pecl_http, HTTP_Request2
Python	http.client, Requests
HTTP	HTTP
C	libcurl
C#	RestSharp
Objective-C	NSURLSession
Ruby	Net::HTTP
OCaml	Cohttp
Dart	http
R	httr, RCurl

Gerar Código de Modelo de Dados

O código de modelo de dados é utilizado para definir schemas e é frequentemente utilizado para serialização quando as APIs enviam dados e para processamento de desserialização quando os dados são recebidos. Depois de o tipo de código SQL ser gerado, também pode definir instruções de criação de tabelas no cenário de criação de tabelas de base de dados para criar tabelas de dados na base de dados.

Para aceder ao modelo de dados, toque no botão Gerar Código no Editor de Schema.

Depois, pode selecionar a linguagem de programação pretendida para o código gerado e configurar preferências específicas de estilo de código.

Linguagens Suportadas

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

Gerar Código na Documentação da API

Na documentação da API gerada pelo Apidog, pode gerar facilmente Código de Cliente e código de Modelo de Dados.

Gerar Server Stubs e SDKs de Cliente#

Como Gerar#

Linguagens/Frameworks Suportados#

Gerar Código de Cliente#

Linguagens Suportadas#

Gerar Código de Modelo de Dados#

Linguagens Suportadas#

Gerar Código na Documentação da API#

Gerar Server Stubs e SDKs de Cliente

Como Gerar

Linguagens/Frameworks Suportados

Gerar Código de Cliente

Linguagens Suportadas

Gerar Código de Modelo de Dados

Linguagens Suportadas

Gerar Código na Documentação da API