Spring 프로젝트 생성
해당 링크를 접속합니다.
-
Java 를 이용할 것 이기 때문에 아래와 같이 설정해줍니다.
-
spring 버전 설정을 해줍니다.
-
이름과 자바 버전을 설정해줍니다.
위와 같이 생성하면
spring 이라는 이름의 프로젝트가 생성되고
아래와 같은 폴더구조를 가지게 됩니다.
Spring test!
- static 폴더아래 public 폴더를 생성합니다.
- index.html을 작성합니다.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>kkorin</title>
</head>
<body>
안녕하세요 kkorin입니다.
</body>
</html>- 실행
Spring controller 작성
controller의 역할?
우선 스프링 프레임워크는 MVC(Model-View-Controller) 패턴을 사용합니다.
controller는 화면(View)와 비즈니스 로직(Model)을 연결시키는 다리 역할을 합니다.
작성해보기!
1.controller 폴더를 생성합니다.
- StudyController 파일을 작성합니다.
package com.asac.spring.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
@Controller
public class StudyController {
@GetMapping("/study")
@ResponseBody
public String helloWorld(){
return "Hello world study";
}
}
- 실행
Swagger 연결
Swagger란?
Swagger란 개발한 REST API를 편리하게 문서화 해주고, 이를 통해서 관리 및 제 3의 사용자가 편리하게 API를 호출해보고 테스트 할 수 있는 프로젝트이다.
dependencies에 추가하면 쉽게 사용할 수 있습니다.
| Annotation | |
|---|---|
| @Api | 클래스를 스웨거의 리소스로 표시 |
| @ApiOperation | 특정 경로의 오퍼레이션 HTTP 메소드 설명 |
| @ApiParam | 오퍼레이션 파라미터에 메타 데이터 설명 |
| @ApiResponse | 오퍼레이션의 응답 지정 |
| @ApiModelProperty | 모델의 속성 데이터를 설명 |
| @ApiImplicitParam | 메소드 단위의 오퍼레이션 파라미터를 설명 |
Swagger 연결해보기
- dependencies 추가
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
이제 Response body와 같은 정보들이 확인이 가능합니다!
참고블로그
Springboot 3.x에 Swagger를 적용시켜보자!
pring Boot Project Initializr (Swagger 연결) #3
Spring) 스프링 Controller 개념과 페이지 연결(주소매핑)
Swagger 란? 무엇인고?
안녕하세요 코린입니다!