imad-server-wiki

IMAD 위키 페이지 백업용 및 기타 스크립트의 변경 이력을 위한 저장소이다.

개요

IMAD 프로젝트의 문서를 작성해서 공유하던 노션의 워크스페이스가 용량(이미지 5MB)이 가득차서 이 저장소로 옮기게 되었다. 추후 회의록을 제외한 대부분의 문서는 여기서 공유될 예정이다.

DTO 클래스 코드 자동 업데이트 스크립트

• 코드 수정 등의 이유로 DTO 클래스의 코드가 변경되었을 때, 파이썬 스크립트를 실행하여 마크다운 페이지의 내부 코드의 업데이트를 수행할 수 있다.

• 클래스가 추가 또는 수정 되었을 시 dto_class_original.md 파일을 업데이트한다. DTO-클래스-명세.md 파일은 스크립트 실행 결과를 저장하고 읽기만 하는 용도이다.

• 스크립트 실행 시 별도의 매개변수는 필요하지 않으나, 마크다운 페이지를 수정하거나 내용을 추가할 때 정해진 형식을 지켜야 한다.

• 중간에 '## '를 사용하여 소제목을 추가할 수 있다.

• 기본적으로 데이터 추가 시 다음과 같은 형식을 따른다.

### {class_name}
>/{github_file_path}

• class_name에는 클래스 이름이 들어가고, 앞에 ### 을 꼭 붙어야한다. ### 뒤에 공백이 들어간다는 것을 명심하자
• github_file_path은 github API를 통하여 소스파일의 코드를 가져오기 위한 경로이다.
• 작성 예시는 다음과 같다.

## 유저

### Gender
>/src/main/java/com/ncookie/imad/domain/user/entity/Gender.java

### AuthProvider
>/src/main/java/com/ncookie/imad/domain/user/entity/AuthProvider.java

// ...