Add Swagger documentation for test data generation

[yunkon-kim]

Ref. #36

This PR will add Swagger documentation for test data generation.

See details below:

[yunkon-kim]

@zcon-cychoi, @jjang-go 안녕하세요.

API call을 통해 (Data Mold 도구가 실행되고 있는) On-premise Linux에 테스트 데이터를 생성해 보려고 합니다.

• Swagger UI 상에서 try it out 활용 예정

이와 관련하여 Request Body sample을 요청드립니다.

[zcon-cychoi]

POST /generate/linux HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Accept-Language: ko,en;q=0.9,en-US;q=0.8,ja;q=0.7,fr;q=0.6,es;q=0.5,ru;q=0.4,pt;q=0.3,ar;q=0.2
Connection: keep-alive
Content-Length: 157
Content-Type: text/plain;charset=UTF-8
Host: 172.24.140.215:8080
Origin: http://172.24.140.215:8080
Referer: http://172.24.140.215:8080/generate/linux
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 Edg/120.0.0.0

{
    "path":"/tmp/dummy",
    "checkTXT":"on",
    "sizeTXT":"1",
}

데이터 생성 경로 path 와 필요한 데이터 타입 check*** 와 size*** 입니다.

[yunkon-kim]

@zcon-cychoi Request body 공유 감사드립니다 ^^

(실수로 PR close를 누르셨을까요? ^^;;)

[yunkon-kim]

API:
POST /generate/linux

Request body:

{
  "accessKey": "string",
  "bucket": "string",
  "checkCSV": "string",
  "checkGIF": "string",
  "checkJSON": "string",
  "checkPNG": "string",
  "checkSQL": "string",
  "checkServerJSON": "string",
  "checkServerSQL": "string",
  "checkTXT": "on",
  "checkXML": "string",
  "checkZIP": "string",
  "databaseName": "string",
  "endpoint": "string",
  "host": "string",
  "password": "string",
  "path": "/tmp/dummy",
  "port": "string",
  "projectId": "string",
  "provider": "string",
  "region": "string",
  "secretKey": "string",
  "sizeCSV": "string",
  "sizeGIF": "string",
  "sizeJSON": "string",
  "sizePNG": "string",
  "sizeSQL": "string",
  "sizeServerJSON": "string",
  "sizeServerSQL": "string",
  "sizeTXT": "1",
  "sizeXML": "string",
  "sizeZIP": "string",
  "username": "string"
}

Result:

ls -al /tmp/dummy/txt/
total 1031300
drwxr-xr-x 2 root root      4096 Dec 19 14:21 .
drwxr-xr-x 3 root root      4096 Dec 19 14:21 ..
-rw-r--r-- 1 root root 105587719 Dec 19 14:21 randomTxt_0.txt
-rw-r--r-- 1 root root 105604619 Dec 19 14:21 randomTxt_1.txt
-rw-r--r-- 1 root root 105601375 Dec 19 14:21 randomTxt_2.txt
-rw-r--r-- 1 root root 105587860 Dec 19 14:21 randomTxt_3.txt
-rw-r--r-- 1 root root 105588700 Dec 19 14:21 randomTxt_4.txt
-rw-r--r-- 1 root root 105623879 Dec 19 14:21 randomTxt_5.txt
-rw-r--r-- 1 root root 105595197 Dec 19 14:21 randomTxt_6.txt
-rw-r--r-- 1 root root 105589526 Dec 19 14:21 randomTxt_7.txt
-rw-r--r-- 1 root root 105606638 Dec 19 14:21 randomTxt_8.txt
-rw-r--r-- 1 root root 105593187 Dec 19 14:21 randomTxt_9.txt

Log:

[2023-12-19T14:21:22+09:00] [info] [server] [genlinux] Genlinux post page accessed
[2023-12-19T14:21:22+09:00] [info] [server] [genlinux] Create dummy data in linux
[2023-12-19T14:21:22+09:00] [info] [server] [genlinux] Start time : 2023-12-19T14:21:22+09:00
[2023-12-19T14:21:22+09:00] [info] [server] [genlinux] Check the operating system
[2023-12-19T14:21:22+09:00] [info] [server] [genlinux] Start dummy generation
[2023-12-19T14:21:22+09:00] [info] [server] [genlinux] Start creating txt dummy
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_0.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_6.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_9.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_7.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_3.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_4.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_8.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_1.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_5.txt
[2023-12-19T14:21:46+09:00] [info] [server] [genlinux] Successfully generated : /tmp/dummy/txt/randomTxt_2.txt
[2023-12-19T14:21:47+09:00] [info] [server] [genlinux] Successfully generated txt dummy
[2023-12-19T14:21:47+09:00] [info] [server] [genlinux] Successfully creating a dummy with Linux
[2023-12-19T14:21:47+09:00] [info] [server] [genlinux] End time : 2023-12-19T14:21:47+09:00
[2023-12-19T14:21:47+09:00] [info] [server] [genlinux] Elapsed time : 24.348274s

[jjang-go]

@yunkon-kim PR은 실수로 닫으셨다고 합니다^^;;

궁금한 게 있어서 여쭤보려 합니다!

swagger를 다 확인해봤는데 gcp가 아닌 api에도 CredentialGCP이 포함이 되어있던데 별도로 사용하려고 포함하신 건가요?

gcp가 아닌 부분은 CredentialGCP을 제거해야 될 거 같습니다!

[yunkon-kim]

@jjang-go

Request Body로 사용되는 GenDataParams struct에 CredentialGCP가 포함되어 있어서요. 사용하지 않아도 포함되어야 했던것으로 기억합니다. 확실하지 않은 부분이라서, 수정해보고 필요 없으면 삭제해야겠네요 ^^

(추가)
이상 없네요 ㅎㅎ 삭제 처리하겠습니다.