Skip to content

API Specification

Eunsang edited this page Sep 2, 2021 · 11 revisions

Client Interface

CLI Tool

  • 터미널 환경 사용자를 위한 CLI 도구인 cbadm을 제공한다.
  • cbadm은 yaml 또는 json 형식의 입출력을 선택적으로 활용이 가능하다.

Restful API

  • REST(Representational State Transfer) 환경 개발자를 위한 REST API를 제공한다.
  • REST API를 위한 별도 라이브러리를 제공하지 않으며, 개발 언어별 REST 표준 라이브러리를 활용할 수 있다.

Go API

  • Go 언어 개발자를 위한 Go API를 제공하며, 전용 클라이언트 라이브러리를 제공한다.
  • Go API는 gRPC(google RPC) 기반으로 개발되었으며, 통신 속도가 빠르고 개발 언어 확장이 가능하다.

Specification and Examples

Version REST API Go API CLI Tool Release Date
v0.4.0 Swagger doc Examples CLI Spec   Examples Jun 2021
v0.3.0 Swagger doc Examples - Dec 2020