Generación de código

Según la especificación de la API, Apidog admite la generación automática de código de negocio para diversos lenguajes y frameworks, incluidos, entre otros, TypeScript, Java, Go, Swift, Objective-C, Kotlin, Dart, C++, C#, Rust y más de 130 lenguajes y frameworks adicionales.

Apidog ofrece tres tipos de generación de código: Generar stubs de servidor y SDKs de cliente, Generar código de cliente y Generar código de modelo de datos.

Generar stubs de servidor y SDKs de cliente: los stubs de servidor son para desarrolladores de API, mientras que los SDKs de cliente son para consumidores de API. Esto produce tanto código del lado del servidor como código del lado del cliente. Los stubs de servidor son implementaciones esqueléticas de endpoints de API en el servidor, mientras que los SDKs de cliente son bibliotecas precompiladas para distintos lenguajes de programación que permiten interactuar con la API.

Generar código de cliente: para consumidores de API. Crea código para que las aplicaciones cliente interactúen con una API.

Generar código de modelo de datos: para consumidores de API. Genera representaciones en código de las estructuras de datos utilizadas en la API. Esto incluye clases o structs que definen la forma de los objetos de petición y respuesta, lo que ayuda a garantizar la seguridad de tipos y la coherencia en toda la aplicación.

Generación de stubs de servidor y SDKs de cliente

La función Generar stubs de servidor y SDKs de cliente de Apidog permite a los desarrolladores optimizar el proceso de implementación de APIs mediante la generación automática de stubs de código del lado del servidor y SDKs del lado del cliente basados en las especificaciones de API definidas dentro de la plataforma.

Los stubs de servidor son plantillas de código que se pueden utilizar para iniciar aplicaciones del lado del servidor, proporcionando una base para implementar los endpoints de API especificados, la gestión de peticiones y la generación de respuestas. Por otro lado, los SDKs de cliente ofrecen fragmentos de código preconfigurados para interactuar con la API desde el lado del cliente, lo que simplifica la integración de la funcionalidad de la API en diversas aplicaciones.

Cómo generar

1. Instale el plugin de generación de código

Haga clic en Generar código en la especificación de la API y seleccione Generar stubs de servidor y SDKs de cliente.

Haga clic en el botón Descargar e instalar en la página de generación de código de negocio.

NOTE

Si su red no puede acceder a Internet, descargue manualmente openapi-generator-cli-7.13.0.jar desde:
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

A continuación, coloque el archivo JAR en el siguiente directorio correspondiente a su sistema:

macOS: ~/Library/Application Support/apidog/

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

Linux: ~/.config/apidog/

El plugin detectará y utilizará automáticamente el JAR local, por lo que no se requiere conexión a Internet.

2. Genere código

Seleccione el código de servidor o cliente deseado y haga clic en Generar código.

3. Utilice una plantilla personalizada

También puede utilizar la función Plantillas de código personalizadas para generar código que se ajuste a las especificaciones arquitectónicas de su equipo y satisfaga una variedad de necesidades individuales.

Lenguajes/frameworks compatibles

Lenguaje	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

Las funciones de las plantillas de código de Apidog se basan en OpenAPI Generator, pero están simplificadas. Puede consultar este Youtube Video para obtener más información sobre las reglas de las plantillas de OpenAPI Generator.

Generación de código de cliente

El código de cliente se utiliza para iniciar peticiones de API en diversos entornos de desarrollo. Haga clic en el botón Generar código de cliente en el lado derecho de la pestaña Documentación en la API.

También puede generar código haciendo clic en el icono de código </> en la pestaña Ejecutar en la API.

NOTE

El código de cliente generado mediante los métodos mencionados incluirá SOLO las especificaciones de la API y NO los valores de los parámetros de la petición. Si desea generar código de cliente que incluya los valores de los parámetros de la petición, primero debe enviar la petición y luego cambiar a la pestaña Petición real. Desplácese hacia abajo para encontrar el código de cliente que incluye los valores de los parámetros.

Lenguajes compatibles

Lenguaje	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

Generación de código de modelo de datos

El código de modelo de datos se utiliza para definir esquemas y se usa comúnmente para la serialización cuando las APIs envían datos y para el procesamiento de deserialización cuando se reciben datos. Después de generar el tipo de código SQL, también puede definir sentencias de creación de tablas en el escenario de creación de tablas de base de datos para crear tablas de datos en la base de datos.

Para acceder al modelo de datos, pulse el botón Generar código en el Editor de esquemas.

Después, puede seleccionar el lenguaje de programación deseado para el código generado y configurar preferencias específicas de estilo de código.

Lenguajes compatibles

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

Generar código en la documentación de API

En la documentación de API generada por Apidog, puede generar fácilmente código de cliente y código de modelo de datos.

Generación de código

Generación de stubs de servidor y SDKs de cliente#

Cómo generar#

Lenguajes/frameworks compatibles#

Generación de código de cliente#

Lenguajes compatibles#

Generación de código de modelo de datos#

Lenguajes compatibles#

Generar código en la documentación de API#

Generación de stubs de servidor y SDKs de cliente

Cómo generar

Lenguajes/frameworks compatibles

Generación de código de cliente

Lenguajes compatibles

Generación de código de modelo de datos

Lenguajes compatibles

Generar código en la documentación de API