라벨이 springboot인 게시물 표시

스프링부트 Swagger API 설치하기 방법 / spring boot 3, swagger-ui

스프링부트를 사용하여 RESTful API를 만들었다면, 지속적인 관리가 필요하다. swagger를 사용하면 스프링부트에서 제작한 API를 관리하고, 문서화하며, 테스트를 할 수 있도록 도와준다. 예전에는 API 테스트를 위해 별도의 페이지를 만들기도 하고, 오롯이 테스트를 위한 페이지를 만들어 사용하기도 했다. 지금은 어떨까? swagger를 사용하면 스프링부트로 만들어진 API를 편하게 테스트하고 관리할 수 있다. Swagger API 문서, 설계 툴 ` swagger `는 대표적인 API 문서관리, 설계 툴이다. API를 만들고 관리한다면 한번쯤 사용해 봤을 것이다. 과거 우리 개발 선배들은  API를 제작하고 테스트를 위해 별도의 페이지를 만들고, 테스트를 했었다. 본인 또한 마찬가지였다. 지금은 어떨까? swagger를 설치하면 만들어진 모든 API를 한번에 보고, 관리하고, 테스트를 할 수 있다. 과거 API 테스트를 위해 삽질했던 모든 경험들이 주마등처럼 지나갔다. 구구절절 말이 많았으나, 이제 스프링부트 프로젝트에 Swagger API 툴을 설치해 보자. 스프링부트에 Swagger API 설치하기 과정 스프링부트에 Swagger API를 사용하려면 먼저 라이브러리를 import 해야 한다. 스프링부트에서 라이브러리를 import 하는 방법은 ` build.gradle ` 파일에 ` implementation ` 키워드를 사용하는 것이다. Swagger-ui 라이브러리는 ` maven repository ` 사이트를 참고하고, 링크는 아래에 연결해 두었다. [ MVN REPOSITORY - SpringDoc OpenAPI Starter WebMVC UI ].  아래는 스프링부트에 Swagger 라이브러리를 설치하는 과정을 작성해 보았다. IntelliJ를 실행한다. ` build.gradle ` 파일을 열기한다. ` Swagger ` 라이브러리를 추가한다. implementation group: 'org.springdoc', na...

스프링부트 프로젝트 만들기 방법 / 웹 애플리케이션 제작의 시작

스프링부트는 웹애플리케이션과 Rest API 제작에 주로 사용된다. 웹호스팅을 사용할 때도 스프링부트에서 제공되는 서비스들도 사용 가능하다. 지금은 거의 필수로 익혀야 되는 백엔드 프레임워크 중 하나가 되었다. 스프링부트 애플리케이션 제작을 위해선 프로젝트 만들기부터 시작한다. 프로젝트 만들기 과정 인텔리제이( IntelliJ ) 실행. Welcome 화면 표시. New Project 버튼 클릭. Project 내용 입력. 좌측 메뉴 / Spring Boot 선택. Name 입력. Location 선택. Group, Artifact, Package Name 입력. Packaging 선택. cafe24 웹호스팅을 사용하려면 war 선택. Next 버튼 클릭. Dependencies 선택. Developer Tools > Lombok 선택. Web > Spring Web 선택. Template Engines > Thymeleaf 선택. Create 버튼 클릭. Spring Boot 프로젝트 생성과 설정. 화면 우측 상단 > 프로젝트 실행 버튼 클릭. 화면 하단 출력창 > Started ~ 메세지 확인. 웹브라우저 실행. Whitelabel Error Page 화면 표시 확인.