Skip to content

Documents

Shiwon Park edited this page Dec 28, 2024 · 1 revision

API DOCS

본 프로젝트의 API DOCS는 @nestjs/swagger를 통해서 구현이 되었으며, 해당 라이브러리의 설정과 관련된 코드는 보통 main.ts에 있다.
각 문서는 아래의 페이지에서 확인할 수 있다.
PROD: https://api.ziggle.gistory.me/api
STG: https://api.stg.ziggle.gistory.me/api

Database Structure

본 프로젝트의 ERD는 dbdocs를 이용해서 구현이 되었으며, schema.prisma 파일이 수정되면, 이것이 자동으로 반영되게 Github action이 구현되어있다. 이는 /.github/workflows/erd.yml에 있다. (만약 수정이 필요하면 해당 파일을 수정할 것.) ERD 문서는 아래 페이지에서 확인할 수 있다.

경고: 현재 ziggle의 database구조가 복잡하여 잘 작동하지 않고 있다. 따라서 수동으로 dbml파일을 만들어줄 필요가 있다.

ERD: https://dbdocs.io/INFOTEAM%20GIST/ziggle

Clone this wiki locally