Spring Boot 및 Swagger를 사용하여 RESTful API 문서 작성

오늘날의 웹 개발에서 RESTful API는 개발자가 웹 사이트와 애플리케이션을 구축하는 데 매우 인기 있는 방법이 되었습니다. RESTful API를 사용하면 개발자는 명확한 API를 구축하여 다른 애플리케이션이나 서비스와 보다 편리하게 상호 작용할 수 있습니다. 이러한 API를 더 잘 관리하고 유지하기 위해서는 문서 작성 및 관리도 매우 중요한 부분이 되었습니다.

Spring Boot는 Java 애플리케이션을 신속하게 구축하기 위한 프레임워크로, 간단하고 빠르며 확장이 쉽습니다. Swagger는 RESTful API를 설계, 구축 및 문서화하는 데 특별히 사용되는 도구로, RESTful API 문서를 빠르게 생성하고 API 요청 및 응답의 샘플 흐름을 자동으로 생성할 수 있습니다.

이 글에서는 Spring Boot와 Swagger를 사용하여 RESTful API 문서를 작성하는 방법을 소개합니다.

1. Spring Boot 프로젝트 생성

먼저 Spring 초기화를 사용하여 https://start.spring.io/를 통해 생성할 수 있는 Spring Boot 프로젝트를 생성해야 합니다. 여기서는 Web과 Swagger 2의 두 가지 종속성을 선택합니다. 생성이 완료되면 프로젝트를 통합 개발 환경으로 가져오고 pom에 Swagger 종속성을 추가합니다.

컨트롤러에 메소드를 추가합니다:

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

클래스에 @RestController 주석을 추가해야 할 뿐만 아니라 이 컨트롤러의 역할을 설명하기 위해 @Api 주석도 사용해야 한다는 점에 유의해야 합니다.

디컴파일된 콘텐츠:

@RestController
public class NumberController {
 
   @ApiOperation(value = "Generate a random number between 1 and 100")
   @RequestMapping(value = "/generateNumber", method = RequestMethod.GET)
   public ResponseEntity<Integer> generateNumber() {
       Random random = new Random();
       int randomNumber = random.nextInt(100) + 1;
       return ResponseEntity.ok(randomNumber);
   }
}

3. Swagger 구성

해당 컨트롤러 개발이 완료되면 Swagger를 구성해야 합니다. Spring Boot 구성 파일 application.properties에 Swagger 관련 구성을 추가합니다.

package com.example.demo.controller;

import io.swagger.annotations.ApiOperation;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.Random;

@RestController
public class NumberController
{

    public NumberController()
    {
    }

    @ApiOperation(value="Generate a random number between 1 and 100")
    @RequestMapping(value="/generateNumber", method=RequestMethod.GET)
    public ResponseEntity generateNumber()
    {
        Random random = new Random();
        int randomNumber = random.nextInt(100) + 1;
        return ResponseEntity.ok(new Integer(randomNumber));
    }
}

주석 설명:

@Api: Spring MVC의 @Controller 및 @RequestMapping 주석과 유사하게 컨트롤러의 역할을 설명하는 데 사용됩니다.

@ApiIgnore: 무시된 API에 사용되며 생성된 API 문서에 표시되지 않습니다.

@ApiOperation: 메서드 이름, 요청 메서드, 요청 매개 변수, 반환 개체 및 메서드나 클래스에 배치할 수 있는 기타 정보를 포함하여 특정 API 작업을 설명하는 데 사용됩니다.

@ApiImplicitParam: 매개변수 이름, 매개변수 유형, 필요성 및 기타 정보를 포함하여 요청 매개변수를 설명하는 데 사용됩니다.

@ApiModel: JavaBean 클래스를 설명하는 데 사용됩니다.

@ApiParam: 매개변수 정보를 설명하는 데 사용됩니다.

@ApiResponses: HTTP 상태 코드, 응답 데이터 및 기타 정보를 포함한 API 응답을 설명하는 데 사용됩니다.

@ApiProperty: JavaBean 클래스의 속성 정보를 설명하는 데 사용됩니다.

4. API 문서 보기

위 구성을 완료한 후 Spring Boot 애플리케이션을 시작하고 http://localhost:8080/swagger-ui.html을 방문합니다. 생성된 API 문서를 브라우저에서 볼 수 있습니다. 여기에서는 요청 메소드, 요청 매개변수, 반환 결과 등 방금 작성한 API의 자세한 정보를 볼 수 있습니다. 동시에 Swagger는 개발자가 참조하고 테스트할 수 있도록 요청 및 응답의 샘플 스트림을 생성할 수도 있습니다.

여기서는 Spring Boot와 Swagger를 사용하여 RESTful API 문서를 작성합니다. 이 방법을 사용하면 개발자는 자신의 API 문서를 보다 빠르게 구축하고 관리할 수 있어 개발 효율성과 유지 관리성이 향상됩니다.

위 내용은 Spring Boot 및 Swagger를 사용하여 RESTful API 문서 작성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!