Open API 및 SDK

2.6.4 버전에서 추가됨

DataFlux Func는 완전한 Open API 지원을 제공하며, 함께 제공되는 DataFlux Func SDK를 사용하여 프로그래밍 방식으로 호출할 수 있습니다.

1. Open API 문서 페이지 활성화

'실험적 기능'에서 Open API 문서 페이지를 활성화할 수 있습니다.

DataFlux Func SDK에는 서명 기능이 포함되어 있으며 단일 파일로 배포됩니다. 사용자는 프로젝트에 직접 넣어 사용할 수 있습니다.

2. Access Key 생성

1. DataFlux Func에 로그인합니다
2. '관리 / 실험적 기능'에서 Access Key 관리를 활성화합니다
3. '관리 / Access Key'에서 '새로 만들기'를 클릭하여 Access Key를 생성합니다

3. SDK를 사용하여 요청 보내기

DataFlux Func SDK는 여러 프로그래밍 언어를 지원하며, 다운로드 주소는 다음과 같습니다:

언어	다운로드 주소	설명
Python	dataflux_func_sdk.py	단일 파일이며, 기본 사용에는 의존성이 없습니다. 업로드 기능은 requests 라이브러리에 의존합니다.
Node.js	dataflux_func_sdk.js	단일 파일이며, 기본 사용에는 의존성이 없습니다. 업로드 기능은 form-data 라이브러리에 의존합니다.
Golang	dataflux_func_sdk.go	단일 파일이며, 완전히 의존성이 없습니다 Demo: dataflux_func_sdk_demo.go

요청 보내기 예시는 다음과 같습니다:

PythonNode.jsGolang

from dataflux_func_sdk import DataFluxFunc

# DataFlux Func 작업 객체 생성
dff = DataFluxFunc(ak_id='ak-xxxxx', ak_secret='xxxxxxxxxx', host='localhost:8088')

# Debug 활성화
dff.debug = True

# GET 요청 보내기
try:
    status_code, resp = dff.get('/api/v1/do/ping')

except Exception as e:
    print(colored(e, 'red'))
    raise

# POST 요청 보내기
try:
    body = {
        'echo': {
            'int'    : 1,
            'str'    : 'Hello World',
            'none'   : None,
            'boolean': True,
        }
    }
    status_code, resp = dff.post('/api/v1/do/echo', body=body)

except Exception as e:
    print(colored(e, 'red'))
    raise

# 파일 업로드
try:
    filename = 'your_file'
    with open(filename, 'rb') as _f:
        file_buffer = _f.read()

    fields = {
        'folder': 'test'
    }

    status_code, resp = dff.upload('/api/v1/resources/do/upload',
        file_buffer=file_buffer,
        filename=filename,
        fields=fields)

except Exception as e:
    print(colored(e, 'red'))
    raise

var fs = require('fs');
var DataFluxFunc = require('./dataflux_func_sdk.js').DataFluxFunc;

// DataFlux Func 작업 객체 생성
var opt = {
  akId    : 'ak-xxxxx',
  akSecret: 'xxxxxxxxxx',
  host    : 'localhost:8088',
};
var dff = new DataFluxFunc(opt);

// Debug 활성화
dff.debug = true;

// GET 요청 보내기
var getOpt = {
  path: '/api/v1/do/ping',
};
dff.get(getOpt, function(err, respData, respStatusCode) {
  if (err) console.error(colored(err, 'red'))

  // POST 요청 보내기
  var postOpt = {
    path: '/api/v1/do/echo',
    body: {
      'echo': {
        'int'    : 1,
        'str'    : 'Hello World',
        'none'   : null,
        'boolean': true,
      }
    }
  };
  dff.post(postOpt, function(err, respData, respStatusCode) {
    if (err) console.error(colored(err, 'red'))

    // 파일 업로드
    var filename = 'your_file';
    var uploadOpt = {
      path      : '/api/v1/resources/do/upload',
      fileBuffer: fs.readFileSync(filename),
      filename  : filename,
      fields    : {
        'folder': 'test'
      },
    };
    dff.upload(uploadOpt, function(err, respData, respStatusCode) {
      if (err) console.error(colored(err, 'red'))
    });
  });
});

package main

import (
    "os"
    "bytes"
    "fmt"
    "io"
    "mime/multipart"

    // DataFlux Func SDK
    "./dataflux_func_sdk"
)

var (
    colorMap = map[interface{}]string{
        "grey":    "\033[0;30m",
        "red":     "\033[0;31m",
        "green":   "\033[0;32m",
        "yellow":  "\033[0;33m",
        "blue":    "\033[0;34m",
        "magenta": "\033[0;35m",
        "cyan":    "\033[0;36m",
    }
)

func main() {
    host := "localhost:8088"
    if len(os.Args) >= 2 {
        host = os.Args[1]
    }

    // DataFlux Func 작업 객체 생성
    dff := dataflux_func_sdk.NewDataFluxFunc("ak-xxxxx", "xxxxxxxxxx", host, 30, false)

    // Debug 활성화
    dff.Debug = true

    // GET 요청 보내기
    _, _, err := dff.Get("/api/v1/do/ping", nil, nil, "")
    if err != nil {
        panic(err)
    }

    // POST 요청 보내기
    body := map[string]interface{}{
        "echo": map[string]interface{}{
            "int"    : 1,
            "str"    : "Hello World",
            "none"   : nil,
            "boolean": true,
        },
    }
    _, _, err = dff.Post("/api/v1/do/echo", body, nil, nil, "")
    if err != nil {
        panic(err)
    }

    // 파일 업로드
    filename := "dataflux_func_sdk_demo.go"
    file, _ := os.Open(filename)
    fileContents, _ := io.ReadAll(file)

    uploadBody := &bytes.Buffer{}
    writer := multipart.NewWriter(uploadBody)

    part, _ := writer.CreateFormFile("files", filename)
    part.Write(fileContents)

    fields := map[string]string{
        "folder": "test",
    }
    for key, value := range fields {
        writer.WriteField(key, fmt.Sprintf("%v", value))
    }

    writer.Close()
    contentType := writer.FormDataContentType()

    _, _, err = dff.Upload("/api/v1/resources/do/upload", filename, "", fields, nil, nil, uploadBody, contentType)
    if err != nil {
        panic(err)
    }
}