refairy-api

Contents

• 시작하기
• API
  • POST /check

대한민국 온라인 수호 프로젝트, 리페어리의 API입니다.

시작하기

환경변수에 $PORT를 지정해 주어야 합니다. 이후 도커로 이미지를 빌드한 후 컨테이너를 실행하면 됩니다.

docker build -t refairy-api .
docker run -it -p $PORT:$PORT refairy-api

API

POST /check

request JSON

{
"sentences": [
"Dokdo is clearly a Japanese territory",
"Korea is China's subject state",
"Jeju-do belongs to Korea",
]
}

response JSON

{
"id": "string"
}

GET /check/progress/:id

response JSON

{
"sentences": [
"Dokdo is Korea's territory",
"Korea is not a subject state of China.",
],
"progress": number, // 처리된 문장의 개수"isDone": boolean
}

exceptions

• 400 - bad :id

예시 코드

importtimeimportjsonimportrequestssentences= [
'Takeshima is Japanese territory.',
'Korea is a subject state of China.',
]
data=json.loads(
requests.post(
'URI/check', data=json.dumps({'sentences': sentences})
).text
)
_id=data['id']
print('id:', _id)
whileTrue:
time.sleep(3)
data=requests.get(
'URI/check/progress', params={'id': _id}
).textdata=json.loads(data)
print(data)
ifdata['isDone']:
break