diff --git a/src/main/java/com/yunhai/bschclassmanage/config/SwaggerConfig.java b/src/main/java/com/yunhai/bschclassmanage/config/SwaggerConfig.java new file mode 100644 index 0000000..22e0b84 --- /dev/null +++ b/src/main/java/com/yunhai/bschclassmanage/config/SwaggerConfig.java @@ -0,0 +1,26 @@ +package com.yunhai.bschclassmanage.config; + +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * SpringDoc configuration for the class management service. + * The application exposes OpenAPI JSON and Swagger UI endpoints. + */ +@Configuration +public class SwaggerConfig { + /** + * Registers the metadata shown in the generated API documentation. + * + * @return OpenAPI metadata for this application + */ + @Bean + public OpenAPI bschClassOpenAPI() { + return new OpenAPI().info(new Info() + .title("BschClass OpenAPI") // Documentation title + .description("School, class, teacher and student management APIs") // Documentation description + .version("1.0.0")); // Documentation version + } +}