[챗봇] 윈도우에서 카카오톡 챗봇을 위한 예제 스킬 서버 구축하기

본문의 내용은 도움말과 경험을 통해 정리한 것입니다. 오픈 빌더에 대한 더욱 자세한 설명은 아래 도움말을 참고하세요.

스킬 서버 도움말: 링크

카카오톡 챗봇 스킬 서버란?

카카오톡 챗봇의 스킬 기능을 사용하기 위해서는 스킬 서버(응답 서버)가 필요합니다. 그럼 이 스킬 서버가 무엇인지 볼까요?

'스킬 서버(Skill Server)'란, 봇 시스템으로부터 스킬 요청을 받고 이에 담긴 정보를 분석하여 적절한 응답하는 것이 스킬 서버의 역할입니다.

그리고 아래는 요청과 응답의 다이어그램입니다.

봇 시스템 요청과 스킬 서버의 응답 - 출처: 카카오 i 오픈 빌더

즉, 사용자가 봇을 이용해 요청을 하면 HTTP 프로토콜의 POST Method가 전달이 되고, 서버에서는 이에 대한 응답을 JSON 구성으로 보낸다는 것입니다.

예제 스킬 서버

예제 스킬 서버 도움말: 링크

오픈 빌더 도움말에서는 ubuntu 16.04 환경에서 예제 스킬 서버를 구성하는 방법을 제공하는데요. 사실 저는 ubuntu 환경에서 개발을 한 경험이 없기 때문에 어떻게 해야 하는지 막막했습니다. 그런데 윈도우에서도 동일한 방법으로 아주 간단하게 예제 스킬 서버를 구현할 수 있다는 것을 알게 됐습니다.

참고로 예제 스킬 서버는 텍스트 문자열을 또는 이미지를 반환하는 두 가지 동작을 수행합니다. 그럼 윈도우 기반에서 예제 스킬 서버를 구축하는 방법을 시작해 보겠습니다.

따라 하기

1. 서버 생성 및 실행하기

아래 링크에 접속하여 설치형 Windows용 nvm을 다운로드하고 설치합니다.

링크: github.com/coreybutler/nvm-windows/releases

Releases · coreybutler/nvm-windows

nvm-windows 다운로드 페이지

설치 과정은 너무 단순하여 생략했습니다. Next 버튼만 몇 번 누르면 설치가 완료됩니다. 다음은 nodejs를 설치할 차례입니다.

링크: nodejs.org/ko/

nodeJS 다운로드 화면

마찬가지로 설치 과정은 단순합니다. Next 버튼만 누르면 설치가 완료됩니다.

nvm 및 nodejs 설치 후 명령 프롬프트를 실행합니다.

명령 프롬프트 실행

아래의 명령어를 입력하면 설치된 nodejs의 버전이 표시됩니다.

node -v

아래처럼 버전이 표시되면 nodejs는 정상적으로 설치되어 있는 것입니다.

설치된 node 버전 확인

스킬 서버를 만들 폴더를 생성합니다. 저는 예시로 skill-server-example이라는 폴더를 C:\\에 생성했습니다.

스킬 서버를 생성할 폴더 생성

아래의 명령어를 입력하여 생성된 폴더로 이동합니다.

cd C:\skill-server-example

그리고 아래의 명령어를 입력하여 프로젝트를 초기화합니다.

npm init

폴더 이동 및 프로젝트 초기화 과정

프로젝트 초기화 과정 중에 입력하는 단계가 있습니다. package name이나 version, description 등의 항목인데요. 위 이미지처럼 똑같이 작성해도 되고, 임의로 작성해도 상관없습니다. 프로젝트 생성이 완료되면 아래와 같이 package.json 파일이 생성됩니다.

프로젝트 초기화 후 package.json이 생성된 모습

다음은 expressjs를 설치할 차례입니다. 아래의 명령어를 입력합니다.

npm i --save express

expressjs 설치하는 모습 

다음으로 morgan, body-parser 라이브러리를 추가합니다.

npm i --save morgan body-parser

morgan, body-parser 라이브러리 설치하는 모습

위 설치 과정이 모두 끝나면 아래와 같은 파일들이 추가됩니다.

설치가 끝난 모습

해당 폴더에 index.js 파일을 생성하고, 아래의 코드를 복사하여 붙여 넣습니다.

const express = require('express');
const app = express();
const logger = require('morgan');
const bodyParser = require('body-parser');

const apiRouter = express.Router();

app.use(logger('dev', {}));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({
  extended: true
}));

app.use('/api', apiRouter);

apiRouter.post('/sayHello', function(req, res) {
  const responseBody = {
    version: "2.0",
    template: {
      outputs: [
        {
          simpleText: {
            text: "hello I'm Ryan"
          }
        }
      ]
    }
  };

  res.status(200).send(responseBody);
});

apiRouter.post('/showHello', function(req, res) {
  console.log(req.body);

  const responseBody = {
    version: "2.0",
    template: {
      outputs: [
        {
          simpleImage: {
            imageUrl: "https://t1.daumcdn.net/friends/prod/category/M001_friends_ryan2.jpg",
            altText: "hello I'm Ryan"
          }
        }
      ]
    }
  };

  res.status(200).send(responseBody);
});

app.listen(3000, function() {
  console.log('Example skill server listening on port 3000!');
});

파일을 저장한 후 다시 명령 프롬프트로 돌아옵니다. 아래의 명령어를 입력하여 서버를 실행할 수 있습니다.

node index.js

서버가 실행된 모습

2. 공유기 설정하기

서버는 실행하고 있지만 어디까지나 로컬에서만 돌고 있는 서버입니다. 외부에서 접속하려면 공유기에서 포트 포워딩을 해줘야 합니다. iptime 공유기 기준으로 포트 포워딩하는 방법은 아래 링크를 참고하시기 바랍니다(타사 공유기를 사용해도 방법은 동일합니다).

[ipTIME] 포트 포워딩 설정으로 외부에서 집에있는 서버 접속하기

[ipTIME] 포트 포워딩 설정으로 외부에서 집에있는 서버 접속하기

저는 아래 이미지처럼 외부 포트 3000으로 설정했습니다.

포트 포워딩 예시

그런데 포트 포워딩 외에도 한 가지 설정을 더 해야 합니다. 바로 DDNS인데요. DDNS를 설정해야 xxx.iptime.org:3000 형태의 주소로 외부 네트워크에서 내부 네트워크에 접속이 가능합니다. 이 또한 아래의 링크를 참고하여 설정하시기 바랍니다.

[ipTIME] DDNS 설정으로 외부에서 쉽게 공유기에 접속하기

[ipTIME] DDNS 설정으로 외부에서 쉽게 공유기에 접속하기

3. 오픈 빌더 사이트에서 스킬 서버 설정하기

지금까지 잘 따라오셨나요? 이제 오픈 빌더 사이트에서 스킬 생성 및 서버를 설정하는 과정이 남았습니다. 오픈 빌더 사이트에 접속한 후 스킬을 생성합니다.

스킬 생성하기

스킬 생성 후 URL 입력 부분에 다음과 같이 입력합니다. 입력하는 URL은 DDNS 주소와 외부 포트 그리고 api/sayHello 구성입니다.

스킬 서버의 주소를 입력하는 화면

URL 입력 후 스킬 서버로 전송 버튼을 클릭하면 응답 메시지와 결과가 표시됩니다.

스킬 서버 응답 결과 보기

위 버튼을 클릭하면서 명령 프롬프트를 보면 POST 요청을 처리했다는 메시지를 확인할 수 있습니다.

명령 프롬프트의 POST 처리 메시지

정리

본문의 내용대로 결과를 얻으셨나요? 알고 나면 별것 아닌 것 같지만, 저는 이를 알기까지 정말 오랜 시간이 걸렸습니다. 결론은 서버를 실행하고, POST 메서드에 특정 행동을 응답하는 코드만 구현하면 되는 것이죠.

추후에는 Microsoft의 Azure 서버와 Synology 서버를 이용한 ASP.NET 스킬 서버를 만드는 방법을 소개하도록 하겠습니다.