docs: restore missing contents and align canonical stage names across docs

This commit is contained in:
2026-07-17 13:35:29 +09:00
parent f3c003fdf3
commit c8ed4742d0
11 changed files with 201 additions and 300 deletions
+19 -8
View File
@@ -29,21 +29,25 @@ grpccanary/
├── protoapi/ # protoc로 컴파일 생성된 Go Stub 코드
├── examples/
│ ├── main.go # 학습 예제 통합 실행 진입점 (수동 전환)
│ ├── jsonexample/ # [1단계] encoding/json 표준 직렬화 예제
│ ├── httpentity/ # [2단계] Gin-gonic 기반 HTTP API 서버 (WIP)
│ └── grpcentity/ # [3단계] gRPC 서비스 구현체 (서버/클라이언트 데모)
│ ├── jsonexample/ # 1단계: JSON 데이터 다루기 실습 예제
│ ├── httpentity/ # 2단계: HTTP & Gin 웹 서버 실습 예제 (WIP)
│ └── grpcentity/ # 3단계: gRPC 통신 구현 실습 예제 (서버/클라이언트 데모)
└── docs/
── MANUSCRIPT.md # JSON, HTTP, gRPC에 대한 통합 상세 개념
── MANUSCRIPT.md # 학습 로드맵 및 각 단계별 심화 가이드로의 안내
├── JSON.md # 1단계: JSON 데이터 다루기 상세 가이드
├── HTTP.md # 2단계: HTTP & Gin 웹 서버 상세 가이드
└── GRPC.md # 3단계: gRPC 통신 구현 상세 가이드
```
### 1단계: JSON 데이터 다루기 (`examples/jsonexample`)
* Go 표준 라이브러리인 `encoding/json`을 활용하여 구조체(Struct)와 JSON 데이터 간의 마샬링(Serialization) 및 언마샬링(Deserialization) 기법을 학습합니다.
### 2단계: Gin 기반 HTTP 웹 서버 (`examples/httpentity`)
### 2단계: HTTP & Gin 웹 서버 (`examples/httpentity`)
* 대중적인 Go 웹 프레임워크 `gin-gonic`을 활용해 RESTful API 사양을 구축하는 방법을 이해합니다. (현재 주석 해제 후 실습하도록 설계된 Work-in-Progress 단계)
### 3단계: gRPC 통신 구현 (`examples/grpcentity`)
* `.proto` 정의를 바탕으로 통신 스키마 계약을 강제하고, Go 언어로 gRPC 서버를 띄워 클라이언트가 날짜/시간, 무작위 비밀번호 및 정수 데이터를 실시간 원격 호출로 송수신하는 분산 통신 기초를 학습합니다.
* `.proto` 정의를 바탕으로 통신 스키마 계약을 강제하고, Go 언어로 gRPC 서버를 띄워 클라이언트가 날짜/시간, 무작위 비밀번호 및 정수 데이터를 실시간 원격 호출로 송수신하는 분산 통신 기초를 학습합니다.
---
@@ -83,15 +87,22 @@ gRPC 예제 실행 시, 서버가 백업 고루틴으로 `:8080` 포트에 대
```text
Serving requests...
Client:
Server Date and Time: 2026-07-12 20:00:00.123456789 +0900 KST
Server Date and Time: 2026-07-12 20:00:00.123456789 +0900 KST m=+1.000000001
Random Password: &c(D7f/G#s%d
Random Integer 1: 42
Random Integer 2: 87
```
### 4. 트러블슈팅
* **`module grpccanary: package ... is not in GOROOT`**:
- 모듈 로드 에러가 발생한 경우, 리포지토리 루트 경로(작업 디렉토리)에서 명령어를 올바르게 실행했는지 재확인하고, `go clean -modcache` 후 `go mod tidy`를 수행해 보십시오.
---
## 📚 추가 학습 리소스
* **[docs/MANUSCRIPT.md](docs/MANUSCRIPT.md)**: JSON, HTTP, gRPC 통신의 원리와 배경지식(REST의 한계와 gRPC 도입 이유 등)을 담은 본 프로젝트 공식 개념
* **[examples/grpcentity/README.md](examples/grpcentity/README.md)**: Protobuf 빌드 컴파일 가이드 및 상세 소스코드 구현체 분석 자료
* **[docs/MANUSCRIPT.md](docs/MANUSCRIPT.md)**: JSON, HTTP, gRPC 통신의 원리와 배경지식(REST의 한계와 gRPC 도입 이유 등)을 담은 학습 로드맵 및 가이드 안내
* **[docs/JSON.md](docs/JSON.md)**: 1단계 JSON 데이터 다루기 상세 학습 가이드
* **[docs/HTTP.md](docs/HTTP.md)**: 2단계 HTTP & Gin 웹 프레임워크 상세 학습 가이드
* **[docs/GRPC.md](docs/GRPC.md)**: 3단계 gRPC & Protobuf 상세 학습 가이드 (컴파일 절차 및 소스코드 구현체 분석 포함)
* **[examples/grpcentity/README.md](examples/grpcentity/README.md)**: gRPC 실습 디렉토리 안내 및 `docs/GRPC.md` 심화 가이드로의 링크