コード生成

API仕様に基づき、ApidogはTypeScript、Java、Go、Swift、Objective-C、Kotlin、Dart、C++、C#、Rustを含む（ただしこれらに限定されない）130以上の言語およびフレームワーク向けのビジネスコードの自動生成をサポートしています。

Apidogは、サーバースタブとクライアントSDKの生成、クライアントコードの生成、データモデルコードの生成の3種類のコード生成を提供しています。

サーバースタブとクライアントSDKの生成：サーバースタブはAPI開発者向けであり、クライアントSDKはAPI利用者向けです。これにより、サーバー側とクライアント側の両方のコードが生成されます。サーバースタブは、サーバー上のAPIエンドポイントの骨組みとなる実装であり、クライアントSDKは、APIとやり取りするための各プログラミング言語向けの事前構築済みライブラリです。

クライアントコードの生成：API利用者向けです。クライアントアプリケーションがAPIとやり取りするためのコードを作成します。

データモデルコードの生成：API利用者向けです。APIで使用されるデータ構造のコード表現を生成します。これには、リクエストおよびレスポンスオブジェクトの形状を定義するクラスまたは構造体が含まれ、アプリケーション全体で型安全性と一貫性を確保するのに役立ちます。

サーバースタブとクライアントSDKの生成

ApidogのサーバースタブとクライアントSDKの生成機能により、開発者はプラットフォーム内で定義されたAPI仕様に基づいてサーバー側コードスタブとクライアント側SDKを自動生成し、API実装プロセスを効率化できます。

サーバースタブは、サーバー側アプリケーションの立ち上げに使用できるコードテンプレートであり、指定されたAPIエンドポイント、リクエスト処理、レスポンス生成を実装するための基盤を提供します。一方、クライアントSDKは、クライアント側からAPIとやり取りするための事前設定済みコードスニペットを提供し、さまざまなアプリケーションへのAPI機能の統合を簡素化します。

生成方法

1. コード生成プラグインをインストールする

API仕様でコードを生成をクリックし、サーバースタブとクライアントSDKの生成を選択します。

ビジネスコード生成ページでダウンロードしてインストールボタンをクリックします。

NOTE

ご利用のネットワークからインターネットにアクセスできない場合は、次からopenapi-generator-cli-7.13.0.jarを手動でダウンロードしてください。
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

次に、JARファイルをご利用のシステムの以下のディレクトリに配置します。

macOS：~/Library/Application Support/apidog/

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

Linux：~/.config/apidog/

プラグインはローカルのJARを自動的に検出して使用するため、インターネット接続は不要です。

2. コードを生成する

目的のサーバーコードまたはクライアントコードを選択し、コードを生成をクリックします。

3. カスタムテンプレートを使用する

カスタムコードテンプレート機能を使用して、チームのアーキテクチャ仕様に準拠し、さまざまな個別のニーズを満たすコードを生成することもできます。

サポートされている言語/フレームワーク

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

TIP

Apidogのコードテンプレート機能はOpenAPI Generatorをベースにしていますが、簡素化されています。OpenAPI generatorテンプレートのルールについて詳しくは、このYoutube Videoを参照できます。

クライアントコードの生成

クライアントコードは、さまざまな開発環境でAPIリクエストを開始するために使用されます。APIのDocumentationタブの右側にあるクライアントコードを生成ボタンをクリックします。

APIのRunタブでコードアイコン</>をクリックしてコードを生成することもできます。

NOTE

上記の方法で生成されたクライアントコードには、API仕様のみが含まれ、リクエストパラメータ値は含まれません。リクエストパラメータ値を含むクライアントコードを生成する場合は、まずリクエストを送信し、その後Actual Requestタブに切り替える必要があります。下にスクロールして、パラメータ値を含むクライアントコードを見つけてください。

サポートされている言語

言語	バリアント
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

データモデルコードの生成

データモデルコードはスキーマを定義するために使用され、APIがデータを送信する際のシリアル化や、データを受信する際のデシリアル化処理で一般的に使用されます。SQLコードタイプを生成した後は、データベースのテーブル作成シナリオでテーブル作成文を定義し、データベース内にデータテーブルを作成することもできます。

データモデルにアクセスするには、Schema Editorでコードを生成ボタンをタップします。

その後、生成コードに使用する目的のプログラミング言語を選択し、特定のコードスタイル設定を構成できます。

サポートされている言語

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

APIドキュメントでコードを生成する

Apidogによって生成されたAPIドキュメントでは、クライアントコードとデータモデルコードを簡単に生成できます。

サーバースタブとクライアントSDKの生成#

生成方法#

サポートされている言語/フレームワーク#

クライアントコードの生成#

サポートされている言語#

データモデルコードの生成#

サポートされている言語#

APIドキュメントでコードを生成する#

サーバースタブとクライアントSDKの生成

生成方法

サポートされている言語/フレームワーク

クライアントコードの生成

サポートされている言語

データモデルコードの生成

サポートされている言語

APIドキュメントでコードを生成する