설정 가이드

이 페이지에선 itdoc의 설정방법에 대해 설명합니다.

주로 itdoc에서 생성되는 문서에 대해 설정할때 사용합니다.

itdoc은 package.json 파일에서 지정할 수 있으며, 설정 예시는 다음과 같습니다.

{
  "itdoc": {
    "output": "./output",
    "document": {
      "baseUrl": "https://petstore-api.com",
      "title": "Petstore API",
      "description": "API documentation for the Petstore application"
    }
  }
}

설정 항목

이 섹션에서는 itdoc의 각 설정 항목을 상세히 설명합니다.

itdoc

항목	설명	기본 값
output	문서가 생성될 디렉토리 경로입니다.	./output

document

itdoc.document는 문서의 메타데이터를 설정하는 부분입니다. 이 설정에 기반하여 OpenAPI 문서의 제목, 설명, 기본 URL 등이 결정됩니다.

항목	설명	기본 값
baseUrl	API 문서에서 링크 생성 시 사용하는 기본 URL입니다.	"http://localhost:8080"
title	API 문서의 제목으로 표시됩니다.	"API Document"
description	API 문서의 설명으로 표시됩니다.	"You can change the description by specifying it in package.json."

다음 단계