[ KOSTA 교육 59일차 ] JUnit과 친해지기 | Swagger

junjun·2024년 7월 30일
0

KOSTA

목록 보기
47/48

Swagger

  • 개발한 REST API를 편리하게 문서화해주고, 이를 통해 관리 및 제 3의 사용자가 편리하게 API를 호출해보고 테스트할 수 있는 프로젝트
@RestController
@RequestMapping("/api")
public class ApiController {
	
    @GetMapping("/
}

Token과 묶어서 REST API Docs를 만들어야한다.

  • 우리도 우리 자체도 토큰을 만들어 REST API 자체를 만들어 서비스를 내보내자!

  • KAKAO Developers 의 Token 발급.

URL vs URI

  • Uniform Resource Locator : 식별자 + 위치 ( 이름과 더불어, 어떤 방식으로 도달할 수 있는지 )

  • Uniform Resources Identifier : 통합 자원 식별자

Swagger의 Annotation

  • Swagger = API Doc을 만들어주는 라이브러리

  • @Operation : API 작업(메서드)에 대한 설명

  • @Parameter : 파라미터 설명

  • @ApiResponse : 메서드의 응답 설명

  • @Schema : 엔티티 설명

  • @RequestBody : 요청 본문에 대한 설명

  • Web 관련 테스트를 Postman이나 화면으로 할 필요도 없고, 이제 JUnit으로 테스트 하면 된다.

0개의 댓글