Jersey는 자바에서 RESTful 웹 서비스를 구축하기위한 많은 도구와 라이브러리를 제공하는 프레임워크입니다. 이것은 API 문서 생성을 위한 편리한 기능도 제공합니다.

REST API 문서를 작성하는 방법은 다음과 같습니다.

1. Maven 종속성 추가: Jersey에는 API 문서를 작성하는 데 도움이되는 여러 라이브러리가 포함되어 있으므로, 프로젝트의 Maven 종속성에 다음을 추가해야합니다.

<dependency>
  <groupId>org.glassfish.jersey.ext</groupId>
  <artifactId>jersey-servlet</artifactId>
  <version>2.31</version>
</dependency>
<dependency>
  <groupId>org.glassfish.jersey.ext</groupId>
  <artifactId>jersey-quick-start</artifactId>
  <version>2.31</version>
</dependency>
<dependency>
  <groupId>io.swagger.core.v3</groupId>
  <artifactId>swagger-jaxrs2</artifactId>
  <version>2.1.6</version>
</dependency>

1. API 문서 주석 작성: Jersey는 Swagger를 통해 자동으로 API 문서를 생성합니다. 따라서 API 엔드 포인트 및 매개 변수에 대한 자세한 설명을 포함하는 주석을 작성해야합니다. 주석은 엔드 포인트 메소드 위에 작성되어야하며 @ApiOperation, @ApiResponses 등의 Swagger 주석을 사용할 수 있습니다.

예를 들어, 다음은 사용자 정보를 가져오는 REST API 엔드 포인트 메소드의 예입니다.

@GET
@Path("/users/{id}")
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "Get user by ID", notes = "Returns a user based on ID")
@ApiResponses(value = {
    @ApiResponse(code = 200, message = "Successful retrieval of user details"),
    @ApiResponse(code = 404, message = "User not found")
})
public User getUser(@PathParam("id") int id) {
    // Logic to retrieve user details
}

1. API 문서 생성 활성화: API 문서 생성을 활성화하려면 프로젝트의 main 메소드에 다음 코드를 추가하십시오.

ResourceConfig config = new ResourceConfig().packages("your.package.name")
    .register(ApiListingResource.class)
    .register(SwaggerSerializers.class);
JaxrsOpenApiContextBuilder.builder().openApiConfiguration(config).buildContext(true);

your.package.name을 프로젝트의 패키지 이름으로 변경해야합니다.

1. API 문서 확인: 프로젝트를 실행 한 후 브라우저에서 다음 URL을 열어보세요: http://localhost:8080/application-path/openapi.json. 여기서 application-path는 프로젝트의 응용 프로그램 경로를 나타냅니다. 여기서 API 문서를 확인할 수 있습니다.

이제 자바 Jersey를 사용하여 REST API 문서를 작성하는 방법을 알게되었습니다. Jersey의 강력한 기능과 Swagger의 지원을 통해 API 문서 작성 프로세스를 간소화 할 수 있습니다.

더 자세한 내용을 확인하려면 다음 참조 자료를 참고하시기 바랍니다:

• Jersey Documentation
• Swagger Documentation
• Jersey Swagger Integration Example