Swagger [2] Annotation (1)

Swagger Annotation (1) ← 본문 링크 Swagger Annotation (2) ← 본문 링크 Swagger Annotation (3) ← 작성 예정 이전 포스팅에서 Swagger의 기본 개념 및 JAVA Spring Boot 환경에 사용하는 방법에 대하여 알아보았다. 이번에는 Annotation에 대하여 알아보고자 한다. Swagger Annotation을 이용하여 API 명세 화면(swagger-ui.html)을 보다 쉽게 Control 할 수 있다. Swagger Annotation(간략) @ApiIgnore class에 붙여 사용하는 Annotation ui 화면에서 보이지 않도록 ignore 설정을 가능케한다. @Api class에 붙여 사용하는 Annotation ui 화면에 ..

• format_list_bulleted Java/Swagger
• · 2021. 12. 30.
• textsms

Swagger [1] 기본 개념 및 사용 방법

Swagger Swagger란 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. 필자가 직접 사용해본 결과, 사용방법이 무척이나 간단하며 편리하게 API 문서화를 진행할 수 있다. 단점이라고 한다면, 이미 어느정도 개발이 완료된 프로젝트에 대해서는 적용이 다소 어려울 수 있다는 점이다. 이미 생성해놓은 모든 API에 별도 적용을 거쳐야 하기 때문이다... 신규 프로젝트에 도입할 때에는, 개발자들이 API Annotation 양식을 지켜가며 작성을 하게 함으로써 아주 간단하게 API 문서화를 할 수 있겠지만 말이다. 하단 출처에 적혀있는 Swagger 홈페이지에서 Demo 및 사용방법 등과 같은 정보를 확인할 ..

• format_list_bulleted Java/Swagger
• · 2021. 12. 23.
• textsms