Geração de Código

Com base na especificação da API, o Apidog oferece suporte à geração automática de código de negócios para vários idiomas e frameworks, incluindo, entre outros, TypeScript, Java, Go, Swift, Objective-C, Kotlin, Dart, C++, C#, Rust e mais de 130 outros idiomas e frameworks.

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

Gerar Stubs de Servidor e SDKs de Cliente: Stubs de Servidor são destinados a desenvolvedores de API, enquanto SDKs de Cliente são destinados a consumidores de API. Isso produz código tanto do lado do servidor quanto do lado do cliente. Stubs de servidor são implementações esqueléticas de endpoints de API no servidor, enquanto 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 usadas na API. Isso inclui classes ou structs que definem o formato dos objetos de requisição e resposta, ajudando a garantir segurança de tipos e consistência em toda a aplicação.

Geração de Stubs de Servidor e SDKs de Cliente

O recurso Gerar Stubs de Servidor e SDKs de Cliente no Apidog permite que desenvolvedores simplifiquem 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 da API definidas na plataforma.

Stubs de Servidor são modelos de código que podem ser usados para iniciar aplicações do lado do servidor, fornecendo uma base para implementar os endpoints de API especificados, o tratamento de requisições e a geração de respostas. Por outro lado, SDKs de Cliente oferecem trechos 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. Instale o plugin de geração de código

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

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

NOTE

Se sua rede não puder acessar a internet, baixe manualmente openapi-generator-cli-7.13.0.jar em:
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

Em seguida, coloque o arquivo 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 detectará e usará automaticamente o JAR local, portanto, nenhuma conexão com a internet será necessária.

2. Gere o código

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

3. Use um modelo personalizado

Você também pode usar o recurso Modelos de Código Personalizados para gerar código que esteja em conformidade com as especificações arquitetônicas da sua equipe para atender a diversas necessidades individuais.

Linguagens/Frameworks Compatíveis

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 (Deprecated), Silex (Deprecated)
PHP	Cliente	PHP
Swift	Cliente	Swift5, Swift4, Swift3 (Deprecated), Swift2 (Deprecated)
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 (Deprecated)
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

Os recursos dos modelos de código do Apidog são baseados no OpenAPI Generator, mas simplificados. Você pode consultar este Vídeo do Youtube para saber mais sobre as regras dos modelos do OpenAPI generator.

Geração de Código de Cliente

O código de cliente é usado para iniciar requisições de API em vários ambientes de desenvolvimento. Clique no botão Gerar Código de Cliente no lado direito da guia Documentação na API.

Você também pode gerar código clicando no ícone de código </> na guia Executar na API.

NOTE

O código de Cliente gerado usando os métodos mencionados incluirá APENAS as especificações da API e NÃO os valores dos parâmetros da requisição. Se você quiser gerar código de Cliente que inclua os valores dos parâmetros da requisição, primeiro será necessário enviar a requisição e, em seguida, alternar para a guia Requisição Real. Role para baixo para encontrar o código de Cliente que inclui os valores dos parâmetros.

Linguagens Compatíveis

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

Geração de Código de Modelo de Dados

O código de modelo de dados é usado para definir schemas e é comumente usado para serialização quando APIs enviam dados e para processamento de desserialização quando os dados são recebidos. Depois que o tipo de código SQL é gerado, você também pode definir instruções de criação de tabela no cenário de criação de tabelas de banco de dados para criar tabelas de dados no banco de dados.

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

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

Linguagens Compatíveis

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, você pode gerar facilmente Código de Cliente e código de Modelo de Dados.

Geração de Stubs de Servidor e SDKs de Cliente#

Como Gerar#

Linguagens/Frameworks Compatíveis#

Geração de Código de Cliente#

Linguagens Compatíveis#

Geração de Código de Modelo de Dados#

Linguagens Compatíveis#

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

Geração de Stubs de Servidor e SDKs de Cliente

Como Gerar

Linguagens/Frameworks Compatíveis

Geração de Código de Cliente

Linguagens Compatíveis

Geração de Código de Modelo de Dados

Linguagens Compatíveis

Gerar Código na Documentação da API