diff --git a/README.md b/README.md index 8e15d4c..f922164 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,8 @@ class Example: # 백엔드 API DOCS +`uv run main.py`으로 백엔드를 실행한 후에, 다음의 url에 접속합니다. + ``` http://localhost:11081/redoc ``` diff --git a/lib/false_true_varifing_task.py b/lib/false_true_varifing_task.py index 45fa782..4b9bde4 100644 --- a/lib/false_true_varifing_task.py +++ b/lib/false_true_varifing_task.py @@ -30,14 +30,19 @@ class FalseTrueVarifingTask: self.task_queue.clear() # 각 addon의 검증 로직에서 해당 함수를 호출하여, 추후 오탐 검증을 위한 작업을 추가할 수 있습니다. - def add_task(self, task_name: str, data: Any): + # TODO: 모델 지정해두기 + def add_task(self, task_name: str, initial_uri: str, data: Any): """ Add a task to the task queue. :param task: The task to be added. """ - self.task_queue.append({ - "task_name": task_name, - "data": data}) + self.task_queue.append( + { + "task_name": task_name, + "initial_uri": initial_uri, + "data": data + } + ) def start_verification(self): """ diff --git a/runner/backend/__init__.py b/runner/backend/__init__.py index 749309d..b917dbe 100644 --- a/runner/backend/__init__.py +++ b/runner/backend/__init__.py @@ -44,6 +44,19 @@ async def start(url: str = Query(..., description="The URL to target for vulnera description=""" 이 엔드포인트는 시스템에 오탐 검증 작업이 시작되었음을 알립니다. 또한 시스템은 미리 준비된 오탐 검증 작업 목록을 반환합니다. + +```json +{ + "payload": [ + { + "task_name": "pkce_task", # 검증 작업의 이름 + "initial_uri": "http://auth.example.com", # browser가 처음 접속할 URI + "data": any # 추가 데이터 + }, + ... + ] +} +``` """, tags=["2nd STEP"] )