윈도우 환경 요청 관리 에러 수정, README.md 반영

2023-11-07 13:30:48 +09:00
parent 76383e8e5f
commit 8eae737de0
4 changed files with 54 additions and 10 deletions
@@ -1,2 +1,52 @@
-## jar 실행 예
-java -jar HTTPSimulator.jar
+# 프로젝트 빌드 및 실행 가이드
+
+이 문서는 simulator를 빌드하고 실행하기 위한 지침을 담고 있습니다.
+
+## 사전 요구 사항
+
+- JDK 1.8
+- Gradle
+
+## 빌드 및 패키징
+
+1. 윈도우 명령 프롬프트 또는 PowerShell을 엽니다.
+2. 프로젝트 루트 디렉토리로 이동합니다.
+3. 다음 명령어를 사용하여 프로젝트를 빌드합니다:
+
+```shell
+gradlew clean bootJar
+```
+
+빌드 프로세스가 완료된 후, build/libs 디렉토리 안에 .jar 파일이 생성됩니다.
+
+## 실행
+
+1. 윈도우 명령 프롬프트 또는 PowerShell을 엽니다.
+
+```shell
+java -jar build/libs/HTTPSimulator.jar 
+
+```
+
+2. 애플리케이션을 중지하려면, 명령 프롬프트에서 'Ctrl + C' 를 누릅니다.
+
+## 요청 관리 주의 사항
+
+1. 요청관리를 사용하기 위해서는 1개 이상의 서버가 등록되어 있어야 합니다.
+
+2. 요청 관리에서 "시뮬레이터 응답관리"에 등록된 목업 API를 호출 할 때는 등록된 uri와 동일하게 호출해야 합니다.
+
+예)
+
+|   응답관리 uri    |   요청 관리 uri   |   응답   |
+|:-------------:|:-------------:|:------:|
+| /api/v1/test  | /api/v1/test  | 200 OK |
+| /api/v1/test/ | /api/v1/test/ | 200 OK |
+| /api/v1/test/ | /api/v1/test  |  404   |
+| /api/v1/test  | /api/v1/test/ |  404   |
+
+3. 요청 시에 URI에 대한 유효성 검사는 하지 않습니다.
+요청 관리에서 send 시 기본경로와 API Path를 보이는대로 합쳐서 요청을 보냅니다. 
+
+4. path 값이 없이 요청이 가능합니다. 
+