Swagger UI¶

Swagger UI는 REST API 서버의 엔드포인트를 시각적으로 표현하고 테스트할 수 있는 도구입니다.
개발자들은 이 도구를 사용하여 API의 사용법을 확인하고, 개발 및 디버깅 과정을 간소화할 수 있습니다.

특징¶

• 자동 문서화: 코드를 기반으로 API 엔드포인트를 탐색하고 문서를 자동으로 생성합니다.
• 인증 및 테스트: 별도의 개발도구를 사용하지 않고 웹 페이지에서 인증처리 및 테스트를 진행할 수 있습니다.

사용법¶

1. Swagger UI 접속¶

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

2. 메인 화면¶

모든 API 엔드포인트가 그룹별로 나열됩니다.

3. 엔드포인트 탐색¶

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

요청 형식¶

각 엔드포인트의 요청 형식과 필요한 파라미터가 나열됩니다.

응답 형식¶

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

4. API 테스트¶

• API 테스트를 별다른 도구 없이 웹상에서 진행할 수 있습니다.

1. Try it out¶

'Try it out' 버튼을 클릭하여 직접 API 요청을 테스트할 수 있습니다.

2. 요청 정보 입력¶

전달할 파라미터 입력 후 Execute 버튼을 눌러 요청을 실행합니다.

3. 응답 확인¶

요청 결과가 화면에 표시됩니다.

5. 인증 처리¶

상단의 Authorize 버튼을 클릭하여 인증을 진행할 수 있습니다.
인증 정보를 입력하고 Authorize 버튼을 클릭하면 보호된 엔드포인트에 접근할 수 있습니다.

6. 추가 기능¶

Example Value와 Model¶

요청과 응답 데이터의 예시와 모델 구조를 제공합니다.

Responses¶

각 상태 코드에 대한 설명과 예시 응답을 확인할 수 있습니다.