Swagger

• Open Api Specification(OAS)를 위한 프레임워크이다.
• API들이 가지고 있는 스펙(spec)을 명세, 관리할 수 있는 프로젝트/문서
• API 사용 방법을 사용자에게 알려주는 문서

기능

1. API Design (API 설계)
   • Swagger-editor를 통해 api를 문서화하고 빠르게 명세 가능
2. API Development
   • Swagger-codepen을 통해 작성된 문서를 통해 SDK를 생성하여 빌드 프로세스를 간소화할 수 있도록 도와준다.
3. API Documentation
   • Swagger-UI를 통해 작성된 API를 시각화시켜준다.
4. API Testing
   • Swagger-Inspector를 통해 API를 시각화하고 빠른 테스팅을 진행할 수 있다.
5. Standardize
   • Swagger-hub를 통해 개인, 팀원들이 API 정보를 공유하는 Hub

프로젝트 응용

페이지 번호를 쿼리스트링으로 입력받으면 해당 페이지에 나오는 상품 데이터를 반환하는 api이다.

이미지가 파라미터로 POST 요청이 들어오면 해당 이미지를 식별하여 상품 데이터를 반환하는 api이다

• app.py에 블루프린트 처럼 다음과 같이 swagger를 적용시켜줘야 한다.

참고 : swagger란//스웨거 사용 예제//flask Restx 공식문서