코드 생성

API 사양을 기반으로 Apidog은 TypeScript, Java, Go, Swift, Objective-C, Kotlin, Dart, C++, C#, Rust 및 기타 130개 이상의 언어와 프레임워크를 포함하되 이에 국한되지 않는 다양한 언어와 프레임워크의 비즈니스 코드 자동 생성을 지원합니다.

Apidog은 세 가지 유형의 코드 생성을 제공합니다. 서버 스텁 및 클라이언트 SDK 생성, 클라이언트 코드 생성, 데이터 모델 코드 생성입니다.

서버 스텁 및 클라이언트 SDK 생성: 서버 스텁은 API 개발자를 위한 것이며, 클라이언트 SDK는 API 소비자를 위한 것입니다. 이는 서버 측 코드와 클라이언트 측 코드를 모두 생성합니다. 서버 스텁은 서버에서 API 엔드포인트를 구현하기 위한 골격 구현체이며, 클라이언트 SDK는 API와 상호 작용하기 위한 다양한 프로그래밍 언어용 사전 구축 라이브러리입니다.

클라이언트 코드 생성: API 소비자를 위한 것입니다. 클라이언트 애플리케이션이 API와 상호 작용할 수 있도록 코드를 생성합니다.

데이터 모델 코드 생성: API 소비자를 위한 것입니다. API에서 사용되는 데이터 구조의 코드 표현을 생성합니다. 여기에는 요청 및 응답 객체의 형태를 정의하는 클래스 또는 구조체가 포함되며, 애플리케이션 전반에서 타입 안전성과 일관성을 보장하는 데 도움이 됩니다.

서버 스텁 및 클라이언트 SDK 생성

Apidog의 서버 스텁 및 클라이언트 SDK 생성 기능을 사용하면 개발자가 플랫폼 내에서 정의된 API 사양을 기반으로 서버 측 코드 스텁과 클라이언트 측 SDK를 자동으로 생성하여 API 구현 프로세스를 간소화할 수 있습니다.

서버 스텁은 서버 측 애플리케이션을 부트스트랩하는 데 사용할 수 있는 코드 템플릿으로, 지정된 API 엔드포인트, 요청 처리 및 응답 생성을 구현하기 위한 기반을 제공합니다. 반면 클라이언트 SDK는 클라이언트 측에서 API와 상호 작용하기 위한 사전 구성된 코드 스니펫을 제공하여, 다양한 애플리케이션에 API 기능을 통합하는 과정을 단순화합니다.

생성 방법

1. 코드 생성 플러그인 설치

API 사양에서 Generate Code를 클릭하고 Generate Server Stubs and Client SDKs를 선택하십시오.

비즈니스 코드 생성 페이지에서 Download and Install 버튼을 클릭하십시오.

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. 코드 생성

원하는 서버 또는 클라이언트 코드를 선택하고 Generate Code를 클릭하십시오.

3. 사용자 지정 템플릿 사용

또한 Custom Code Templates 기능을 사용하여 팀의 아키텍처 사양에 부합하는 코드를 생성하고 다양한 개별 요구 사항을 충족할 수 있습니다.

지원되는 언어/프레임워크

언어	서버/클라이언트	프레임워크
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 탭 오른쪽에 있는 Generate Client Code 버튼을 클릭하십시오.

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에서 Generate Code 버튼을 탭하십시오.

그런 다음 생성된 코드에 사용할 원하는 프로그래밍 언어를 선택하고 특정 코드 스타일 기본 설정을 구성할 수 있습니다.

지원되는 언어

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

API 문서에서 코드 생성

Apidog에서 생성된 API 문서에서는 Client Code와 Data Model code를 쉽게 생성할 수 있습니다.

서버 스텁 및 클라이언트 SDK 생성#

생성 방법#

지원되는 언어/프레임워크#

클라이언트 코드 생성#

지원되는 언어#

데이터 모델 코드 생성#

지원되는 언어#

API 문서에서 코드 생성#

서버 스텁 및 클라이언트 SDK 생성

생성 방법

지원되는 언어/프레임워크

클라이언트 코드 생성

지원되는 언어

데이터 모델 코드 생성

지원되는 언어

API 문서에서 코드 생성