documentation 2

API 문서화(Documentation)

API 문서 API 사용법을 정리한 문서단순 구두로 설명하거나 메시지로 공유하는 방식의 한계 → API 사용법을 정리한 문서를 만드는 API 문서화(Documentation) 필요 조직에 맞게 완벽하게 커스터마이징 가능별도의 학습 없이 누구나 문서 작성 및 수정 가능코드가 변경될 때마다 문서를 따로 수정해야 함 (코드 변경 시 문서를 수정하지 않는다면, 문서와 실제 API가 달라지는 신뢰도 문제 발생)  API 문서에 담는 정보들Endpoint(어떤 URL에 요청해야 하는지)HTTP 메서드(GET, POST, PUT, DELETE...)필요한 헤더(Header) 정보요청 시 전송할 데이터 형식응답 데이터의 구조예외 상황 에러 코드 안내API 문서는 조직에 따라 개발과 문서화에 사용하는 툴이 다르기 때문에..

WidgetKit - Developing a WidgetKit strategy

WidgetKit 전략 구상하기 위젯, 워치 컴플리케이션, 라이브 액티비티 구현 계획을 세울 때, 그 특징과 작업, 관련 프레임워크 및 제약 사항을 살펴보자.  개요WidgetKit을 사용하여 위젯, 워치 컴플리케이션, Live Activities를 구축하세요. 이러한 기능을 통해, 플랫폼과 기기들을 아우르는 생태계를 조성하여, 앱의 범위를 확장할 수 있습니다. 위젯, 컴플리케이션, Live Activities는 WidgetKit, SwiftUI 및 App Intents를 포함한 관련 프레임워크 세트를 사용하여, 제한적이지만 효과적이고 눈길을 사로잡는 공간을 차지합니다. 이들 간의 디자인, 기능 및 코드는 유사하기 때문에, 코드와 디자인 구성 요소를 재사용하기에 완벽한 대상입니다. 앱 개발 과정에서 비용..

728x90