Tạo mã

Dựa trên đặc tả API, Apidog hỗ trợ tự động tạo mã nghiệp vụ cho nhiều ngôn ngữ và framework khác nhau, bao gồm nhưng không giới hạn ở TypeScript, Java, Go, Swift, Objective-C, Kotlin, Dart, C++, C#, Rust và hơn 130 ngôn ngữ và framework khác.

Apidog cung cấp ba loại Tạo mã: Tạo Server Stubs và Client SDKs, Tạo mã Client, và Tạo mã Data Model.

Tạo Server Stubs và Client SDKs: Server Stubs dành cho nhà phát triển API, trong khi Client SDKs dành cho người tiêu thụ API. Tính năng này tạo ra cả mã phía server và phía client. Server stubs là các triển khai khung của các endpoint API trên server, trong khi Client SDKs là các thư viện được xây dựng sẵn cho nhiều ngôn ngữ lập trình khác nhau để tương tác với API.

Tạo mã Client: Dành cho người tiêu thụ API. Tạo mã cho các ứng dụng client để tương tác với API.

Tạo mã Data Model: Dành cho người tiêu thụ API. Tạo các biểu diễn mã của cấu trúc dữ liệu được sử dụng trong API. Điều này bao gồm các class hoặc struct xác định hình dạng của các đối tượng yêu cầu và phản hồi, giúp đảm bảo an toàn kiểu và tính nhất quán trong toàn bộ ứng dụng.

Tạo Server Stubs và Client SDKs

Tính năng Tạo Server Stubs và Client SDKs trong Apidog giúp nhà phát triển hợp lý hóa quy trình triển khai API bằng cách tự động tạo các code stub phía server và SDK phía client dựa trên đặc tả API được định nghĩa trong nền tảng.

Server Stubs là các mẫu mã có thể được sử dụng để khởi tạo nhanh các ứng dụng phía server, cung cấp nền tảng để triển khai các endpoint API đã chỉ định, xử lý yêu cầu và tạo phản hồi. Mặt khác, Client SDKs cung cấp các đoạn mã được cấu hình sẵn để tương tác với API từ phía client, đơn giản hóa việc tích hợp chức năng API vào nhiều ứng dụng khác nhau.

Cách tạo

1. Cài đặt plugin tạo mã

Nhấp vào Generate Code trong đặc tả API, và chọn Generate Server Stubs and Client SDKs.

Nhấp vào nút Download and Install trong trang tạo mã nghiệp vụ.

NOTE

Nếu mạng của bạn không thể truy cập internet, vui lòng tải xuống thủ công openapi-generator-cli-7.13.0.jar từ:
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

Sau đó đặt tệp JAR vào thư mục sau tương ứng với hệ thống của bạn:

macOS: ~/Library/Application Support/apidog/

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

Linux: ~/.config/apidog/

Plugin sẽ tự động phát hiện và sử dụng JAR cục bộ, vì vậy không cần kết nối internet.

2. Tạo mã

Chọn mã server hoặc client mong muốn, rồi nhấp vào Generate Code.

3. Sử dụng mẫu tùy chỉnh

Bạn cũng có thể sử dụng tính năng Custom Code Templates để tạo mã phù hợp với các đặc tả kiến trúc của đội ngũ nhằm đáp ứng nhiều nhu cầu riêng biệt.

Ngôn ngữ/Framework được hỗ trợ

Ngôn ngữ	Server/Client	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	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

Các tính năng của mẫu mã Apidog dựa trên OpenAPI Generator nhưng đã được đơn giản hóa. Bạn có thể tham khảo Video Youtube này để tìm hiểu thêm về các quy tắc của mẫu OpenAPI generator.

Tạo mã Client

Mã client được sử dụng để khởi tạo các yêu cầu API trong nhiều môi trường phát triển khác nhau. Nhấp vào nút Generate Client Code ở phía bên phải của tab Documentation trong API.

Bạn cũng có thể tạo mã bằng cách nhấp vào biểu tượng mã </> trong tab Run của API.

NOTE

Mã Client được tạo bằng các phương thức nêu trên sẽ CHỈ bao gồm đặc tả API và KHÔNG bao gồm các giá trị tham số yêu cầu. Nếu bạn muốn tạo mã Client bao gồm các giá trị tham số yêu cầu, trước tiên bạn cần gửi yêu cầu, sau đó chuyển sang tab Actual Request. Cuộn xuống để tìm mã Client có bao gồm các giá trị tham số.

Ngôn ngữ được hỗ trợ

Ngôn ngữ	Biến thể
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

Tạo mã Data Model

Mã data model được sử dụng để định nghĩa schema, và thường được dùng cho quá trình serialization khi API gửi dữ liệu và quá trình deserialization khi nhận dữ liệu. Sau khi loại mã SQL được tạo, bạn cũng có thể định nghĩa các câu lệnh tạo bảng trong kịch bản tạo bảng cơ sở dữ liệu để tạo bảng dữ liệu trong cơ sở dữ liệu.

Để truy cập data model, nhấn vào nút Generate Code trong Schema Editor.

Sau đó, bạn có thể chọn ngôn ngữ lập trình mong muốn cho mã được tạo và cấu hình các tùy chọn kiểu mã cụ thể.

Ngôn ngữ được hỗ trợ

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

Tạo mã trong Tài liệu API

Trong tài liệu API được tạo bởi Apidog, bạn có thể dễ dàng tạo Mã Client và mã Data Model.

Tạo Server Stubs và Client SDKs#

Cách tạo#

Ngôn ngữ/Framework được hỗ trợ#

Tạo mã Client#

Ngôn ngữ được hỗ trợ#

Tạo mã Data Model#

Ngôn ngữ được hỗ trợ#

Tạo mã trong Tài liệu API#

Tạo Server Stubs và Client SDKs

Cách tạo

Ngôn ngữ/Framework được hỗ trợ

Tạo mã Client

Ngôn ngữ được hỗ trợ

Tạo mã Data Model

Ngôn ngữ được hỗ trợ

Tạo mã trong Tài liệu API