Perkhidmatan Web SpringBoot - Bahagian Konfigurasi Awal

Dalam siaran ini, kami akan meneroka cara mengkonfigurasi OpenAPI dalam aplikasi Spring Boot anda dan menambah ubah hala yang mudah daripada URL akar ke UI Swagger. Persediaan ini akan menambah baik dokumentasi API anda dan menjadikannya lebih mudah diakses oleh pembangun.

Konfigurasi Kacang OpenAPI

Pertama, mari buat kelas konfigurasi untuk menyesuaikan dokumentasi OpenAPI kami:

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"))
                );
    }
}

Konfigurasi ini mencipta kacang OpenAPI tersuai dengan maklumat asas tentang API anda. Anda boleh menyesuaikannya lagi dengan menambahkan lebih banyak butiran, seperti maklumat hubungan, lesen atau dokumentasi luaran.
Kami boleh menggunakan GitProperties untuk memberikan butiran lanjut.

Pengawal Ubah Arah URL Root

Seterusnya, mari buat pengawal untuk mengubah hala pengguna daripada URL akar ke UI Swagger:

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";
    }
}

Pengawal mudah ini menggunakan @GetMapping untuk URL akar ("/") dan mengubah hala ke halaman HTML UI Swagger.

Mengemas kini aplikasi.yaml

Fail konfigurasi ini, sering dinamakan application.yml, memainkan peranan penting dalam menentukan pelbagai aspek gelagat aplikasi anda.

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

Konfigurasi YAML yang disediakan meliputi beberapa bahagian utama aplikasi Spring Boot anda:

1. Sifat Aplikasi:

nama: Mentakrifkan nama aplikasi, di sini ditetapkan kepada katalog buku.

versi: Merujuk pemegang tempat, mungkin diisi semasa proses binaan, untuk menentukan versi aplikasi.

1. Konfigurasi MVC:

problemdetails.enabled: Mendayakan laporan masalah terperinci dalam badan respons untuk pengecualian.

1. Titik Akhir Pengurusan:

endpoints.web.exposure.include: '*':** Mendedahkan semua titik akhir penggerak untuk tujuan pemantauan dan pengurusan.

info.git.mode: penuh: Menyediakan maklumat Git terperinci dalam titik akhir /info.

1. Konfigurasi Pelayan:

port: Menetapkan port di mana pelayan mendengar permintaan masuk (lalai 8080, di sini ditetapkan kepada 8888).

servlet.context-path: Mentakrifkan laluan konteks untuk aplikasi, memastikan permintaan dihalakan dengan betul.

error.whitelabel.enabled: false: Melumpuhkan halaman ralat label putih lalai, membenarkan mesej ralat yang lebih bermaklumat semasa pembangunan.

Menambah banner.txt

1. Cipta fail banner.txt

Buat fail baharu bernama banner.txt dalam direktori src/main/resources projek Spring Boot anda.

2. Tambahkan butiran perkhidmatan pada banner.txt

Anda boleh menambah sebarang teks atau seni ASCII pada fail ini. Berikut ialah contoh:

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"))
                );
    }
}

Pendekatan ini menambah sentuhan profesional pada permulaan aplikasi anda dan memberikan maklumat berharga sepintas lalu.

Menambah 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";
    }
}

Pengeluaran Lapisan: Mencipta lapisan berasingan untuk kebergantungan, meningkatkan kecekapan binaan dan mengurangkan kemas kini saiz imej.
Binaan Berbilang peringkat: Menggunakan proses binaan berbilang peringkat untuk memisahkan persekitaran binaan daripada persekitaran masa jalan, menghasilkan imej akhir yang lebih kecil dan cekap.
Imej Asas Ringan: Menggunakan imej asas minimum seperti azul/zulu-openjdk-alpine:21-jre-tanpa kepala untuk mengurangkan lagi saiz imej.

Pendekatan ini membawa kepada binaan yang lebih pantas, saiz imej yang lebih kecil dan prestasi keseluruhan yang lebih baik untuk aplikasi Spring Boot anda dalam bekas Docker.

Atas ialah kandungan terperinci Perkhidmatan Web SpringBoot - Bahagian Konfigurasi Awal. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!