[opficdev]

🔗 연관된 이슈

• closed 메인 리드미에 라이브러리 설명을 추가한다 #67

📝 작업 내용

📌 요약

• README.md를 한국어 기본 문서로 전환하고 README.en.md로 영문 문서를 분리
• 선언형 요청 API의 사용법과 HTTP 요청 실행 계층을 README에 정리
• 공개 API의 /// 설명을 한국어로 다듬고 Draw.io 산출물 추적을 제외

🔍 상세

• 설치, 공개 API, 요청 빌더와 NXEndpoint 사용 예시를 한영 문서에 동일하게 구성
• 상대 경로와 절대 URL 경계, 구조화된 로깅, 오류 처리, 전송 측정값, 인증 토큰 갱신, 응답 캐시, 재시도 정책의 적용 조건을 문서화
• 캐시 응답과 진행 중 요청의 공유, 인증 갱신, 재시도, 전송, 응답 검증 및 디코딩 순서를 요청 흐름 다이어그램으로 추가
• README.ko.md를 제거하고 언어 선택 링크와 목차를 현재 문서 구조에 맞게 정리
• Swift 소스의 공개 DocC 자연어 설명만 한국어로 수정하고 실행 로직과 공개 API 형식은 유지
• Nexa.drawio를 저장소 추적에서 제외하고 .gitignore에 추가

🔄 변경 흐름

flowchart TB
    application[소비자 앱] --> client[NXAPIClient]

    subgraph publicAPI[공개 API]
        client
        builder[NXRequestBuilder<br/>NXTypedRequestBuilder]
        endpoint[NXEndpoint]
        extensionPoints[공개 확장 계약<br/>NXHTTPTransport, NXHTTPInterceptor,<br/>NXAuthTokenProvider, NXLogger, NXServerErrorDecoder]

        client --> builder
        client --> endpoint
        endpoint --> builder
    end

    subgraph core[핵심 모델]
        configuration[NXClientConfiguration]
        requestSpec[RequestSpec]
    end

    client --> configuration
    builder --> requestSpec

    subgraph runtime[실행 계층]
        sharedState[클라이언트 공유 상태<br/>선택적 응답 캐시 저장소<br/>인증 갱신 조정자]
        executor[NXRequestExecutor]
        assembler[NXRequestAssembler]
        interceptors[NXInterceptorChain<br/>재시도 → 인증 → 클라이언트 인터셉터<br/>요청 인터셉터 → 로깅 → 선택적 응답 캐시]
        configuredTransport[설정된 전송 구현]
        validation[NXResponsePipeline<br/>응답 검증]
        decoding[NXResponsePipeline<br/>선택적 응답 디코딩]
    end

    client -->|소유| sharedState
    sharedState -.->|빌더를 거쳐 실행에 전달| executor

    builder --> executor
    configuration --> executor
    requestSpec --> executor

    executor -->|요청 조립| assembler
    assembler -->|조립한 URLRequest| interceptors

    interceptors -->|전송 필요| configuredTransport
    configuredTransport --> validation
    interceptors -->|전송 없이 응답| validation

    validation -->|원시 응답 반환| rawResponse[원시 응답<br/>NXRawResponse]
    validation -->|응답 디코딩| decoding
    decoding --> decodedResponse[디코딩된 응답<br/>Response]

    extensionPoints -.->|인터셉터, 인증, 로깅| interceptors
    extensionPoints -.->|전송| configuredTransport
    extensionPoints -.->|오류 디코더| validation

Loading

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 447dc44f6c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".