Menghasilkan Kode

Berdasarkan spesifikasi API, Apidog mendukung pembuatan kode bisnis secara otomatis untuk berbagai bahasa dan framework, termasuk tetapi tidak terbatas pada TypeScript, Java, Go, Swift, Objective-C, Kotlin, Dart, C++, C#, Rust, serta lebih dari 130 bahasa dan framework lainnya.

Apidog menawarkan tiga jenis Pembuatan Kode: Generate Server Stubs and Client SDKs, Generate Client Code, dan Generate Data Model Code.

Generate Server Stubs and Client SDKs: Server Stubs ditujukan untuk pengembang API, sedangkan Client SDKs ditujukan untuk konsumen API. Ini menghasilkan kode sisi server dan sisi klien. Server stubs adalah implementasi kerangka dari endpoint API pada server, sedangkan Client SDKs adalah pustaka siap pakai untuk berbagai bahasa pemrograman guna berinteraksi dengan API.

Generate Client Code: Untuk konsumen API. Membuat kode bagi aplikasi klien untuk berinteraksi dengan API.

Generate Data Model Code: Untuk konsumen API. Menghasilkan representasi kode dari struktur data yang digunakan dalam API. Ini mencakup class atau struct yang mendefinisikan bentuk objek permintaan dan respons, sehingga membantu memastikan keamanan tipe dan konsistensi di seluruh aplikasi.

Menghasilkan Server Stubs dan Client SDKs

Fitur Generate Server Stubs and Client SDKs di Apidog memberdayakan pengembang untuk menyederhanakan proses implementasi API dengan secara otomatis menghasilkan stub kode sisi server dan SDK sisi klien berdasarkan spesifikasi API yang didefinisikan di dalam platform.

Server Stubs adalah templat kode yang dapat digunakan untuk memulai aplikasi sisi server, menyediakan fondasi untuk mengimplementasikan endpoint API yang ditentukan, penanganan permintaan, dan pembuatan respons. Di sisi lain, Client SDKs menawarkan cuplikan kode yang telah dikonfigurasi sebelumnya untuk berinteraksi dengan API dari sisi klien, sehingga menyederhanakan integrasi fungsionalitas API ke berbagai aplikasi.

Cara Menghasilkan

1. Instal plugin pembuatan kode

Klik Generate Code dalam spesifikasi API, lalu pilih Generate Server Stubs and Client SDKs.

Klik tombol Download and Install pada halaman pembuatan kode bisnis.

NOTE

Jika jaringan Anda tidak dapat mengakses internet, silakan unduh openapi-generator-cli-7.13.0.jar secara manual dari:
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

Kemudian letakkan file JAR di direktori berikut sesuai sistem Anda:

macOS: ~/Library/Application Support/apidog/

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

Linux: ~/.config/apidog/

Plugin akan secara otomatis mendeteksi dan menggunakan JAR lokal, sehingga koneksi internet tidak diperlukan.

2. Hasilkan kode

Pilih kode server atau klien yang diinginkan, lalu klik Generate Code.

3. Gunakan templat kustom

Anda juga dapat menggunakan fitur Custom Code Templates untuk menghasilkan kode yang sesuai dengan spesifikasi arsitektur tim Anda guna memenuhi berbagai kebutuhan individual.

Bahasa/Framework yang Didukung

Bahasa	Server/Klien	Framework
Java	Server	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	Klien	Android, Java
PHP	Server	Laravel, Lumen, Symfony, Ze Ph, Slim4, Slim (Deprecated), Silex (Deprecated)
PHP	Klien	PHP
Swift	Klien	Swift5, Swift4, Swift3 (Deprecated), Swift2 (Deprecated)
Kotlin	Server	Kotlin Server, Kotlin Spring, Kotlin Vertx
Kotlin	Klien	Kotlin
JavaScript	Klien	Apollo, Flowtyped, Closure Angular
Node.js	Server	Express, GraphQL Express
TypeScript	Klien	Axios, Fetch, Redux Query, Angular, Angularjs, Jquery, Rxjs, Node, Aurelia, Inversify
C++	Server	Pistache Server, Qt5 Qhttpengine Server, Restbed Server
C++	Klien	Qt5 Client, Restsdk, Tizen
C#	Server	C# Nancyfx
C#	Klien	C#, C# Netcore, C# Dotnet2
ASP.NET	Server	ASP.NET Core
Dart	Klien	Dart, Dart Dio, Dart Jaguar
Go	Server	Go Server, Go Gin Server
Go	Klien	Go, Go (Experimental)
C	Klien	C
Objective-C	Klien	Objective-C
Scala	Server	Scala Akka Http Server, Scala Finch, Scala Lagom Server, Scala Play Server
Scala	Klien	Scala Akka, Scala Gatling, Scala Sttp, Scalaz, Scala Httpclient (Deprecated)
Clojure	Klien	Clojure
Groovy	Klien	Groovy
Python	Server	Python Aiohttp, Python Blueplanet, Python Flask
Python	Klien	Python, Python (Experimental)
Rust	Server	Rust Server
Rust	Klien	Rust
Ruby	Server	Ruby On Rails, Ruby Sinatra
Ruby	Klien	Ruby
R	Klien	R
Perl	Klien	Perl
PowerShell	Klien	PowerShell
JMeter	Klien	JMeter
Bash	Klien	Bash
Lua	Klien	Lua
F#	Server	F# Functions, F# Giraffe Server
OCaml	Klien	OCaml
Erlang	Server	Erlang Server
Erlang	Klien	Erlang Client, Erlang Proper
Flash	Klien	Flash
Elixir	Klien	Elixir
Haskell	Server	Haskell
Haskell	Klien	Haskell Http Client
Elm	Klien	Elm
Nim	Klien	Nim
Ada	Server	Ada Server
Ada	Klien	Ada
Apex	Klien	Apex
Eiffel	Klien	Eiffel

TIP

Fitur templat kode Apidog didasarkan pada OpenAPI Generator tetapi disederhanakan. Anda dapat merujuk ke Youtube Video ini untuk mempelajari lebih lanjut tentang aturan templat OpenAPI generator.

Menghasilkan Kode Klien

Kode klien digunakan untuk memulai permintaan API di berbagai lingkungan pengembangan. Klik tombol Generate Client Code di sisi kanan tab Documentation dalam API.

Anda juga dapat menghasilkan kode dengan mengklik ikon kode </> di tab Run dalam API.

NOTE

Kode Klien yang dihasilkan menggunakan metode yang disebutkan hanya akan MENCAKUP spesifikasi API dan TIDAK mencakup nilai parameter permintaan. Jika Anda ingin menghasilkan kode Klien yang mencakup nilai parameter permintaan, Anda perlu terlebih dahulu mengirim permintaan, lalu beralih ke tab Actual Request. Gulir ke bawah untuk menemukan kode Klien yang mencakup nilai parameter.

Bahasa yang Didukung

Bahasa	Varian
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

Menghasilkan Kode Model Data

Kode model data digunakan untuk mendefinisikan skema, dan umumnya digunakan untuk serialisasi ketika API mengirim data serta pemrosesan deserialisasi ketika data diterima. Setelah jenis kode SQL dihasilkan, Anda juga dapat mendefinisikan pernyataan pembuatan tabel dalam skenario pembuatan tabel basis data untuk membuat tabel data di basis data.

Untuk mengakses model data, ketuk tombol Generate Code di Schema Editor.

Setelah itu, Anda dapat memilih bahasa pemrograman yang diinginkan untuk kode yang dihasilkan dan mengonfigurasi preferensi gaya kode tertentu.

Bahasa yang Didukung

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

Menghasilkan Kode dalam Dokumentasi API

Dalam dokumentasi API yang dihasilkan oleh Apidog, Anda dapat dengan mudah menghasilkan Client Code dan Data Model code.

Menghasilkan Server Stubs dan Client SDKs#

Cara Menghasilkan#

Bahasa/Framework yang Didukung#

Menghasilkan Kode Klien#

Bahasa yang Didukung#

Menghasilkan Kode Model Data#

Bahasa yang Didukung#

Menghasilkan Kode dalam Dokumentasi API#

Menghasilkan Server Stubs dan Client SDKs

Cara Menghasilkan

Bahasa/Framework yang Didukung

Menghasilkan Kode Klien

Bahasa yang Didukung

Menghasilkan Kode Model Data

Bahasa yang Didukung

Menghasilkan Kode dalam Dokumentasi API