ReDoc¶

ReDoc은 API 문서화를 위한 도구로, 직관적이고 정돈된 인터페이스를 통해 REST API를 시각화하고 탐색할 수 있습니다.
ReDoc은 단일 페이지 애플리케이션으로 설계되어, API 문서를 한 눈에 쉽게 파악할 수 있도록 도와줍니다.

특징¶

• 자동 문서화: 코드를 기반으로 API 엔드포인트를 탐색하고 문서를 자동으로 생성합니다.
• 단일 페이지 애플리케이션: 모든 API 문서를 한 페이지에서 탐색할 수 있습니다.
• 가독성: 각 엔드포인트의 요청과 응답 형식을 명확하게 표시합니다.

사용법¶

1. Redoc 접속¶

• 브라우저에서 http://<서버 주소>/redoc에 접속합니다.

2. 메인 화면¶

모든 API 엔드포인트가 한 페이지 내에서 확인할 수 있으며, 좌측에는 엔드포인트별 그룹이 나열됩니다.

3. 엔드포인트 탐색¶

• 엔드포인트를 클릭하면 상세 정보가 표시됩니다.

요청 형식¶

각 엔드포인트의 요청 형식과 필요한 파라미터를 확인할 수 있습니다.

인증이 필요한 엔드포인트의 경우, 인증 정보를 확인할 수 있습니다.

응답 형식¶

가능한 응답 코드와 데이터 형식이 설명됩니다.

응답 코드를 클릭 시, 상세한 응답 정보를 확인할 수 있습니다.