Skip to content

Latest commit

 

History

History
149 lines (106 loc) · 3.93 KB

Guide_KO.md

File metadata and controls

149 lines (106 loc) · 3.93 KB
Raw

API 사용 가이드

한국어
Engligh
日本語

Before Usage

본 챗봇은 개발자(yymin1022)와 지인들이 평소에 주로 하는 대화 헛소리 를 대신 해주는 봇을 개발하고자 기획되었습니다. 챗봇의 언행이 일반인이 이해하기에는 다소 난해할 수 그리고 어질어질할 수 있으니 활용에 참고하시기 바랍니다.

Install

Setup Using Docker

DockerHub

컨테이너 내부 80번 포트를 외부로 포워딩 해야합니다.

docker pull yymin1022/wa-api
docker run --name wa -p 8080:80 wa-api

Setup Manually

git clone https://github.com/yymin1022/Wa_API.git
chmod +x Wa_API/*.sh
./setupServer.sh

Requirements

Ubuntu 20.04 LTS amd64 에서 테스트 되었습니다.

다른 플랫폼에서 이용하고자 할 경우 수정이 필요할 수 있습니다.

setupServer.sh 를 이용해 설치할 경우, 아래 Requirements이 자동으로 설치됩니다.

sudo apt install apache2 libapache2-mod-wsgi-py3 python3 python3-pip python3-flask
sudo python3 -m pip install -r requirements.txt

Run

setupServer.sh 를 이용해 설치할 경우, Apach2 서비스가 자동으로 등록됩니다.

아래 명령을 이용해 서비스를 시작시킬 수 있습니다.

service apache2 start
/etc/init.d/apache2 start

How To Use

http://localhost:port/getMessage 로 POST Restful 데이터셋을 전송합니다.

서버에 API 요청을 하는 경우 포맷은 다음과 같습니다.

{
    "msg": "와..",
    "room": "채팅방 1",
    "sender": "yymin1022"
}
Variable Data Type Data Content
msg String 메시지 내용
room String 채팅방 이름
sender String 채팅 발화자

서버의 API 반환 결과값은 다음과 같습니다.

{
    "RESULT": {
        "RESULT_CODE": 0,
        "RESULT_MSG": "RESULT OK"
        },
    "DATA": {
        "msg":"갑부;;",
        "room":"채팅방 1",
        "sender":"yymin1022"
        }
}
Variable Data Type Data Content
RESULT_CODE String API 처리 결과 코드
RESULT_MSG String API 처리 결과 메시지
msg String 메시지 내용
room String 채팅방 이름
sender String 채팅 발화자
API 처리 결과 코드
0 정상 처리
100 와..봇이 지원하지 않는 메시지
200 기타 오류(RESULT_MSG 참고)

RESULT_MSG로 반환된 메시지 내용을 채팅으로 반환할 때, \\m과 \\n 두가지 종류의 개행문자가 포함될 수 있습니다.

\\n은 한 메시지 내에서의 개행을 의미하고, \\m은 개행으로 나뉘어진 각 메시지를 따로따로 전송하도록 의도하였으니, 챗봇으로 구현시 참고하시기 바랍니다.

API Example

아래 예시는 응답 가능한 메시지의 일부입니다.

모든 메시지 내용은 message.py 에서 확인하실 수 있습니다.

Message Content Reply
꺼라 전기세 아깝다ㅡㅡ;;
ㄹㅇㅋㅋ ㄹㅇㅋㅋ
멈춰 멈춰!!
무야호 그만큼 신나신다는거지~
아.. 글쿤.. / 그래요.. 등 8종
와.. 갑부;; / 기만;; / ㄹㅇ;; 등 7종
와! 샌즈! 아시는구나! 이거 겁.나.어.렵.습.니.다.
응애 응애 나 애기 등 3종
이런.. 안됐군요.. 등 2종
자라 전기세 아깝다ㅡㅡ;;
자야지 구라ㅡㅡ;;
^^7 ^^7

Example

Wa.. for Discord
Wa.. for Telegram

Want Contribute?

봇 제작에 참여하고자 하시는 경우, message.py 를 참고해 코드를 작성하시고, Pull Request를 등록해주시면 주기적으로 확인하여 올바른지 검토한 뒤 Merge 해드립니다!