목록API문서화 (2)

개발 메모장

[Spring] Swagger 3.0 - API 문서화

데이터 수신을 위한 API 개발을 위해 이전 테스트한 Swagger보다 좀 더 나아간 Swagger 개발을 해야하는 업무가 생겼습니다.클라이언트에게 변경사항이 생길 때마다 알려주는 것보다 API문서화하여 처리하는 편이 멀리 봤을 때 간편하다고 생각하여 아래와 같이 처리하였습니다.#. dependency 추가 Swagger 3 버전을 사용합니다.implementation 'io.springfox:springfox-boot-starter:3.0.0'implementation 'io.springfox:springfox-swagger-ui:3.0.0'#. SwaggerConfigSwagger 사용을 위한 Configuration 및 Bean 설정을 합니다.Docket > securityContexts 및 sec..
Spring 2024. 7. 4. 15:49
[Spring] Swagger(스웨거) 사용방법

#. Swagger란 무엇인가? RESTful 웹 서비스를 생성, 삭제, 설명 및 시각화하기 위한 프레임워크입니다.사람이 읽을 수 있는 형식으로 API를 설계해 주는 역할을 합니다.대화형 API문서, 클라이언트 SDK, 서버 스텁을 자동으로 생성하는 도구를 제공합니다.즉, API문서 생성을 자동화하고 테스트 및 탐색을 위한 UI를 제공하는 것을 의미합니다.#. 스웨거 사용방법스웨거 사용을 위한 라이브러리를 추가합니다.implementation 'io.springfox:springfox-swagger2:2.9.2'implementation 'io.springfox:springfox-swagger-ui:2.9.2'스웨거를 처리할 config 파일을 생성해 줍니다.import..
Spring 2024. 2. 19. 13:41
이전 Prev 1 Next 다음