Description on DB Column

 

 

🎯 요구사항

Fastify + Swagger (OPEN API 3.0.3) 를 쓴다면 JSON Schema 를 정의하는 일이 익숙할 것이다.

허나, 프로젝트 초반일수록 DB 스키마는 물론 API 가 변경되는 일이 잦아 JSON Schema 변경도 잦아진다.

개발과 문서화 모두를 맡은 개발자 입장에선 여간 귀찮은 일이 아닐 수 없다.

 

 

ORM없이
DB 스키마를 변경할 때마다 연결된 DB로부터
자동으로 JSON Schema 를 받아올 순 없을까?

 

 

 

구원 투수

GitHub - SpringTree/pg-tables-to-jsonschema: A command-line utility and module to turn postgres tables into JSON Schemas

위 라이브러리를 사용하면 DB 정보만 입력하면 JSON Schema 받아올 수 있다.

CLI, Node.js 모두 지원한다.

 

여기서 'description'이 은근 자주쓰이는데, 

아예 DB 테이블에 `comment` 를 달아두면 JSON Schema 로 받아올 때도 description 이 포함된다.

 

JSON Schema 추출 결과

JSON Schema 뽑아오기

 

🔑 테이블과 컬럼에 코멘트 달기

  개발을 하면 할 수록 실제 코드와 제품 - 문서가 너무 많이 분리되어 있으면 동기화 하는데 굉장한 노력이 소요된다는 것을 느낀다. 하다못해 컬럼이름 하나만 바꿔도 앱단에서 전체 코드를 수정 해야한다.

 

이럴 바에는 PostgreSQL DB에 정의된 스키마 정보를 JSON Schema 로 싹 앱단으로 끌어올 수 있는 툴이 있지 않을까?
하고 찾은 툴이 pg-tables-to-jsonschema 이다. 

 

👉🏻 사용법

구문이 굉장히 간결하고, MySQL 이나 PostgreSQL 모두 같은 문법을 따른다.

 

🔗 Reference

COMMENT