찾다
Javajava지도 시간SpringBoot 웹 서비스 - 부분 초기 구성

SpringBoot Web Service - Part  Initial Configuration

이 게시물에서는 Spring Boot 애플리케이션에서 OpenAPI를 구성하고 루트 URL에서 Swagger UI로의 편리한 리디렉션을 추가하는 방법을 살펴보겠습니다. 이 설정을 통해 API 문서가 개선되고 개발자가 더 쉽게 접근할 수 있게 됩니다.

OpenAPI 빈 구성

먼저 OpenAPI 문서를 사용자 정의하기 위한 구성 클래스를 만들어 보겠습니다.

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI(GitProperties gitProperties) {
        return new OpenAPI()
                .info(new Info()
                        .title("Book Catalog API")
                        .description("REST API for managing a book catalog. Application version: "+ gitProperties.get("build.version"))
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("Book Catalog Team")
                                .email("support@bookcatalog.com")
                                .url("https://github.com/vlaship/book-catalog"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT"))
                );
    }
}

이 구성은 API에 대한 기본 정보가 포함된 사용자 정의 OpenAPI Bean을 생성합니다. 연락처 정보, 라이선스, 외부 문서 등 세부정보를 추가하여 이를 더욱 맞춤화할 수 있습니다.
GitProperties를 사용하여 자세한 내용을 제공할 수 있습니다.

루트 URL 리디렉션 컨트롤러

다음으로 사용자를 루트 URL에서 Swagger UI로 리디렉션하는 컨트롤러를 만들어 보겠습니다.

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class OpenApiController {
    @GetMapping("/")
    public String index() {
        return "redirect:swagger-ui.html";
    }
}

이 간단한 컨트롤러는 루트 URL("/")에 @GetMapping을 사용하고 Swagger UI HTML 페이지로 리디렉션합니다.

application.yaml 업데이트 중

application.yml이라고도 불리는 이 구성 파일은 애플리케이션 동작의 다양한 측면을 정의하는 데 중요한 역할을 합니다.

spring:
  application:
    name: book-catalog
    version: '@project.version@'
  mvc:
    problemdetails:
      enabled: true

management:
  endpoints:
    web:
      exposure:
        include: '*'
  info:
    git:
      mode: full

server:
  port: 8888
  servlet:
    context-path: /${spring.application.name}
  error:
    whitelabel:
      enabled: false

제공된 YAML 구성은 Spring Boot 애플리케이션의 여러 주요 영역을 다룹니다.

  1. 애플리케이션 속성:

name: 애플리케이션의 이름을 정의합니다. 여기서는 book-catalog로 설정됩니다.

version: 애플리케이션 버전을 지정하기 위해 빌드 프로세스 중에 채워질 가능성이 있는 자리 표시자를 참조합니다.

  1. MVC 구성:

problemdetails.enabled: 예외에 대한 응답 본문에서 자세한 문제 보고서를 활성화합니다.

  1. 관리 엔드포인트:

endpoints.web.exposure.include: '*':** 모니터링 및 관리 목적으로 모든 액추에이터 엔드포인트를 노출합니다.

info.git.mode: full: /info 엔드포인트에서 자세한 Git 정보를 제공합니다.

  1. 서버 구성:

포트: 서버가 들어오는 요청을 수신하는 포트를 설정합니다(기본값 8080, 여기서는 8888로 설정됨).

servlet.context-path: 애플리케이션의 컨텍스트 경로를 정의하여 요청이 올바르게 라우팅되도록 합니다.

error.whitelabel.enabled: false: 기본 화이트라벨 오류 페이지를 비활성화하여 개발 중에 더 많은 정보를 제공하는 오류 메시지를 제공합니다.

배너.txt 추가

1. 배너.txt 파일 생성

Spring Boot 프로젝트의 src/main/resources 디렉터리에 배너.txt라는 새 파일을 만듭니다.

2. 배너.txt에 서비스 세부정보 추가

이 파일에는 텍스트나 ASCII 아트를 추가할 수 있습니다. 예는 다음과 같습니다.

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI(GitProperties gitProperties) {
        return new OpenAPI()
                .info(new Info()
                        .title("Book Catalog API")
                        .description("REST API for managing a book catalog. Application version: "+ gitProperties.get("build.version"))
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("Book Catalog Team")
                                .email("support@bookcatalog.com")
                                .url("https://github.com/vlaship/book-catalog"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT"))
                );
    }
}

이 접근 방식은 애플리케이션 시작에 전문적인 손길을 더하고 귀중한 정보를 한눈에 제공합니다.

Dockerfile 추가

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class OpenApiController {
    @GetMapping("/")
    public String index() {
        return "redirect:swagger-ui.html";
    }
}

레이어 추출: 종속성을 위한 별도의 레이어를 생성하여 빌드 효율성을 높이고 이미지 크기 업데이트를 줄입니다.
다단계 빌드: 다단계 빌드 프로세스를 활용하여 빌드 환경을 런타임 환경에서 분리하여 최종 이미지를 더 작고 효율적으로 만듭니다.
경량 기본 이미지: azul/zulu-openjdk-alpine:21-jre-headless와 같은 최소 기본 이미지를 사용하여 이미지 크기를 더욱 줄입니다.

이 접근 방식을 사용하면 Docker 컨테이너 내 Spring Boot 애플리케이션의 빌드 속도가 빨라지고 이미지 크기가 작아지며 전반적인 성능이 향상됩니다.

위 내용은 SpringBoot 웹 서비스 - 부분 초기 구성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.
Intellij Idea는 로그를 출력하지 않고 스프링 부팅 프로젝트의 포트 번호를 어떻게 식별합니까?Intellij Idea는 로그를 출력하지 않고 스프링 부팅 프로젝트의 포트 번호를 어떻게 식별합니까?Apr 19, 2025 pm 11:45 PM

IntellijideAultimate 버전을 사용하여 봄을 시작하십시오 ...

데이터베이스 쿼리 조건을 구축하기 위해 엔티티 클래스 변수 이름을 우아하게 얻는 방법은 무엇입니까?데이터베이스 쿼리 조건을 구축하기 위해 엔티티 클래스 변수 이름을 우아하게 얻는 방법은 무엇입니까?Apr 19, 2025 pm 11:42 PM

데이터베이스 작업에 MyBatis-Plus 또는 기타 ORM 프레임 워크를 사용하는 경우 엔티티 클래스의 속성 이름을 기반으로 쿼리 조건을 구성해야합니다. 매번 수동으로 ...

Redis 캐시 솔루션을 사용하여 제품 순위 목록의 요구 사항을 효율적으로 실현하는 방법은 무엇입니까?Redis 캐시 솔루션을 사용하여 제품 순위 목록의 요구 사항을 효율적으로 실현하는 방법은 무엇입니까?Apr 19, 2025 pm 11:36 PM

Redis 캐싱 솔루션은 제품 순위 목록의 요구 사항을 어떻게 인식합니까? 개발 과정에서 우리는 종종 a ... 표시와 같은 순위의 요구 사항을 처리해야합니다.

Java 객체를 어레이로 안전하게 변환하는 방법은 무엇입니까?Java 객체를 어레이로 안전하게 변환하는 방법은 무엇입니까?Apr 19, 2025 pm 11:33 PM

Java 객체 및 배열의 ​​변환 : 캐스트 유형 변환의 위험과 올바른 방법에 대한 심층적 인 논의 많은 Java 초보자가 객체를 배열로 변환 할 것입니다 ...

분류를 구현하고 그룹의 일관성을 유지하기 위해 이름을 숫자로 변환하려면 어떻게합니까?분류를 구현하고 그룹의 일관성을 유지하기 위해 이름을 숫자로 변환하려면 어떻게합니까?Apr 19, 2025 pm 11:30 PM

많은 응용 프로그램 시나리오에서 정렬을 구현하기 위해 이름으로 이름을 변환하는 솔루션, 사용자는 그룹으로, 특히 하나로 분류해야 할 수도 있습니다.

전자 상거래 플랫폼 SKU 및 SPU 데이터베이스 설계 : 사용자 정의 속성과 귀속없는 제품을 모두 고려하는 방법은 무엇입니까?전자 상거래 플랫폼 SKU 및 SPU 데이터베이스 설계 : 사용자 정의 속성과 귀속없는 제품을 모두 고려하는 방법은 무엇입니까?Apr 19, 2025 pm 11:27 PM

전자 상거래 플랫폼에서 SKU 및 SPU 테이블의 디자인에 대한 자세한 설명이 기사는 전자 상거래 플랫폼에서 SKU 및 SPU의 데이터베이스 설계 문제, 특히 사용자 정의 판매를 처리하는 방법에 대해 논의 할 것입니다 ...

팀 구성원이 공유 할 수있는 아이디어에서 SpringBoot 프로젝트의 기본 실행 구성 목록을 설정하는 방법은 무엇입니까?팀 구성원이 공유 할 수있는 아이디어에서 SpringBoot 프로젝트의 기본 실행 구성 목록을 설정하는 방법은 무엇입니까?Apr 19, 2025 pm 11:24 PM

SpringBoot 프로젝트를 설정하는 방법 Intellij를 사용하여 Idea에서 기본 실행 구성 목록 ...

See all articles

핫 AI 도구

Undresser.AI Undress

Undresser.AI Undress

사실적인 누드 사진을 만들기 위한 AI 기반 앱

AI Clothes Remover

AI Clothes Remover

사진에서 옷을 제거하는 온라인 AI 도구입니다.

Undress AI Tool

Undress AI Tool

무료로 이미지를 벗다

Clothoff.io

Clothoff.io

AI 옷 제거제

Video Face Swap

Video Face Swap

완전히 무료인 AI 얼굴 교환 도구를 사용하여 모든 비디오의 얼굴을 쉽게 바꾸세요!

뜨거운 도구

SublimeText3 영어 버전

SublimeText3 영어 버전

권장 사항: Win 버전, 코드 프롬프트 지원!

mPDF

mPDF

mPDF는 UTF-8로 인코딩된 HTML에서 PDF 파일을 생성할 수 있는 PHP 라이브러리입니다. 원저자인 Ian Back은 자신의 웹 사이트에서 "즉시" PDF 파일을 출력하고 다양한 언어를 처리하기 위해 mPDF를 작성했습니다. HTML2FPDF와 같은 원본 스크립트보다 유니코드 글꼴을 사용할 때 속도가 느리고 더 큰 파일을 생성하지만 CSS 스타일 등을 지원하고 많은 개선 사항이 있습니다. RTL(아랍어, 히브리어), CJK(중국어, 일본어, 한국어)를 포함한 거의 모든 언어를 지원합니다. 중첩된 블록 수준 요소(예: P, DIV)를 지원합니다.

SublimeText3 Mac 버전

SublimeText3 Mac 버전

신 수준의 코드 편집 소프트웨어(SublimeText3)

MinGW - Windows용 미니멀리스트 GNU

MinGW - Windows용 미니멀리스트 GNU

이 프로젝트는 osdn.net/projects/mingw로 마이그레이션되는 중입니다. 계속해서 그곳에서 우리를 팔로우할 수 있습니다. MinGW: GCC(GNU Compiler Collection)의 기본 Windows 포트로, 기본 Windows 애플리케이션을 구축하기 위한 무료 배포 가능 가져오기 라이브러리 및 헤더 파일로 C99 기능을 지원하는 MSVC 런타임에 대한 확장이 포함되어 있습니다. 모든 MinGW 소프트웨어는 64비트 Windows 플랫폼에서 실행될 수 있습니다.

Atom Editor Mac 버전 다운로드

Atom Editor Mac 버전 다운로드

가장 인기 있는 오픈 소스 편집기