ID: key_26_13_03_24_20_01_10_83700 Created date: 3월 24 2026 화요일, 13주 20:01 #tas befw schema

연관 문서

User 분석

  • 대상 User
    • 서비스 기획자
    • 서비스 개발자
  • User별 분석
    • 기획자
      • 특성
        • 전산에 대한 이해도 낮음
        • DB 설정, 접속 등에 귀찮음
      • 대응
        • 간편한 인터페이스 제공
        • 손쉬운 수정 및 업데이트
        • 이력 관리 및 누가 왜 변경했는지 이력 관리
    • 개발자
      • 특성
        • 귀찮은거 싫음
        • 개발 건이 대기하고 있음
        • 공통화를 위해 시간을 쓰고 싶지 않음
        • 공통화 통해서 시스템 장애를 맞고 싶지 않아
      • 대응
        • 스키마 별도 개발 안해도됨
        • 손쉽게 공통 스키마 적용
        • IDE를 통한 변경점 Validation

Purpose

  • 모듈 간 메시지 Schema 공통 관리
    • Management of Message Schema between system modules
  • 기획자, 화면 통해 Schema 수정 및 업데이트
    • Architect, Design and upsate message schema with UI

Work Flow

  • 스키마 등록 / 업데이트
    • 기획자
      • 스키마 현황 조회
      • 기존 등록된 스키마 참고하여 스키마 설계
      • 추가 혹은 업데이트 수행
    • 기획자
      • 스키마 추가 및 업데이트
      • 개발자에게 알림
    • 개발자
      • 각 소스에서 버튼 클릭하여 변경된 스키마 적용
      • 변경된 스키마, 소스 코드 변경점 확인
      • IDE 통해 Validation 수행

Feature

  • 조회
    • 목적
      • 등록된 Schema 조회
    • 주요 정보
      • 기본적인 Schema 정보 (메시지 정의 등)
      • 업데이트 이력
        • 일시, 작업자, 변경 사유, 버전
  • 신규 생성
    • 목적
      • 신규 등록할 Schema를 선정
  • 업데이트
  • 스키마 변경 알림
  • 메시지 스펙 설명
    • 특성, 상황 등을 언어로 설명
  • 예시 항목
    • 각 항목 별로 예시 처리
  • 옵션 항목 설정
    • 항목 별로 Option 설정
  • 필수 항목 설정
  • 항목별 데이터 타입 설정
  • 스키마간 상속 가능
  • 변경 요청 및 승인 체계

구현 방안

  • BackEnd 에서 직접 GitHub API 사용
  • Flow
    • 기획자가 필드 추가
    • Admin Server, GitHub API 호출
      • 파일 읽기
      • 파일 수정
      • Pull Request 생성
    • 개발 리더, PR 리뷰 및 승인
    • Merge
    • GitHub Action 실행
    • Nexus 배포
  • DB 필요 케이스
    • 변경 제안 이력 관리
    • 기획자별 제안 현황 추적
  • 30 Mar
    • 해당 기능은 어려우니, 일단 실제 개발단계에서 원하는 대로 사용할 수 있는지 먼저 검증

연관 메일