본문 바로가기

웹/웹 개발11

[웹 개발] API 명세서 작성 tip https://tech.kakaoenterprise.com/127 [TW] API 문서 톺아보기시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), July(김정인)입니다. 테크니컬라이팅 팀에서는 Kakao i 기술문서 사이트에 카카오엔터프라이즈가 개tech.kakaoenterprise.com정말 정말 좋은 글이다! 꼭 한 번씩 읽어보자 https://cobinding.tistory.com/165 [BackEnd] API 명세서 작성 가이드 라인 | 작성 예시프로젝트에서 API 명세서와 ERD 설계를 맡았다. API 명세서를 작성해본 적이 없어서 최대한 공식적인 자료를 바탕으로 찾아보다가 사막의 오아시스같은 글을 발견해서 정리하고 두고두고 보려고cobi.. 2024. 10. 6.
[웹 개발] 데이터 사전의 테이블 정의(ERD 설계) 데이터 사전(데이터 딕셔너리)은 DBMS에서 데이터에 대한 메타데이터, 즉 데이터에 관한 정보를 저장하고 관리하는 도구 또는 파일이다. 이는 데이터의 구조, 의미, 제약 조건, 관계 등을 명확하게 설명하여 사용자가 데이터를 효율적으로 사용할 수 있도록 돕는다.데이터 사전의 주요 요소는 다음과 같다테이블 정보: DB에 저장된 테이블들의 이름, 설명, 각 테이블의 열(Column) 목록 및 열의 데이터 유형, 길이 등이 포함된다.열(Column) 설명: 각 열의 이름, 데이터 유형, 기본값, 허용되는 값의 범위, NULL 값 허용 여부, 외래 키(Foreign Key)와 같은 제약 조건 등이 기록된다.제약 조건: 테이블 간의 관계, 외래 키(Foreign Key) 및 기본 키(Primary Key)와 같은 .. 2024. 10. 5.