Swagger UI는 프로그램 안에서 사용하는 기능 목록을 한눈에 볼 수 있는 페이지를 만들어 준다. 그리고 거기서 버튼을 클릭해서 그 기능이 제대로 동작하는지 확인할 수 있게 해준다. 복잡한 개발 도구를 몰라도, Swagger UI 화면에서 API라는 프로그램의 작은 기능들을 테트할 수 있다.
- Swagger 프로젝트 폴더 생성
- C:\development\swagger_project 폴더를 생성하고, 관련 파일들을 이동
- Swagger 관련 파일 생성
- server.js와 swagger.yaml 파일을 생성하고 필요한 코드를 작성
- swagger.yaml에는 OpenAPI 3.0 문서를 작성하여 /example API를 정의
- Swagger UI 서버 설정
- Node.js를 사용하여 Express 서버를 구축
- 필요한 패키지(swagger-ui-express, yamljs, express)를 설치
- Swagger UI 실행 및 확인
- 서버를 실행한 후, 브라우저에서 http://localhost:3000/api-docs로 접속하여 API 문서를 확인
- Swagger UI에서 API를 테스트하고 응답 결과를 확인
'개발스터디' 카테고리의 다른 글
| PostgreSQL 데이터 복원 및 깨진 문자셋 문제 해결 정리 (1) | 2024.12.17 |
|---|---|
| Spring Boot 프로젝트 실행과 Swagger UI 설정 도전 (1) | 2024.12.12 |