상품 관리 BackEnd (SpringBoot)

상품 관리 REST API 서버 구현

상품 테이블 정의

Spring Boot REST API 구현

API 명세서 자동 생성 - OpenAPI(Swagger)

API 테스트

상품 테이블 정의

상품

Draw ERD with your team members. All states are shared in real time. And it's FREE. Database modeling tool.

https://www.erdcloud.com/d/5DQHMRPBdEnm8tZtG

DROP TABLE IF EXISTS `products`;

CREATE TABLE `products` (
	`no`	BIGINT	NOT NULL AUTO_INCREMENT PRIMARY KEY	COMMENT 'PK',
	`id`	VARCHAR(64)	NOT NULL	COMMENT 'UK',
	`title`	VARCHAR(100)	NOT NULL	COMMENT '상품명',
	`content`	TEXT	NULL	COMMENT '설명',
	`likes`	BIGINT	NULL	DEFAULT 0	COMMENT '좋아요',
	`img`	TEXT	NULL	COMMENT '이미지경로',
	`created_at`	TIMESTAMP	NOT NULL	DEFAULT CURRENT_TIMESTAMP	COMMENT '등록일자',
	`updated_at`	TIMESTAMP	NOT NULL	DEFAULT CURRENT_TIMESTAMP	COMMENT '수정일자'
);
SQL
복사

Spring Boot REST API 구현

요청 메소드	요청 경로	항목	비고
GET	/products	상품 목록
GET	/products/{id}	상품 조회
POST	/products	상품 등록
PUT	/products	상품 수정
DELETE	/products/{id}	상품 삭제

•

domain

◦

Product.java

•

Mapper

◦

ProductMapper.xml

◦

BaseMapper.java

◦

ProductMapper.java

•

Service

◦

BaseService.java

◦

ProductService.java

◦

ProductServiceImpl.java

•

Controller

◦

ProductController.java 

◦

@CrossOrigin("*")

◦

@RestController

▪

 sp-crud

API 명세서 자동 생성 - OpenAPI(Swagger)

SpringDoc OpenAPI Starter WebMVC UI

Maven Repository: org.springdoc » springdoc-openapi-starter-webmvc-ui » 2.7.0

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui/2.7.0

// Springdoc openapi
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0'
SQL
복사

build.gradle

plugins {
	id 'java'
	id 'war'
	id 'org.springframework.boot' version '3.4.1'
	id 'io.spring.dependency-management' version '1.1.6'
}

group = 'com.aloha'
version = '0.0.1-SNAPSHOT'

java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(17)
	}
}

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:3.0.4'
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	runtimeOnly 'com.mysql:mysql-connector-j'
	annotationProcessor 'org.projectlombok:lombok'
	providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:3.0.4'
	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
	// Springdoc openapi
	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0'
}

tasks.named('test') {
	useJUnitPlatform()
}
SQL
복사

SwaggerConfig.java

import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;


@Configuration
public class SwaggerConfig {
 
    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("aloha") // 그룹명 설정
                .pathsToMatch("/**") // 경로 설정
                .build();
    }

    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("상품 관리 Proejct API")
                        .description("상품 관리 프로젝트 API 입니다.")
                        .version("v0.0.1"));
    }

    
}
Java
복사

기본 경로

localhost

http://localhost:8080/swagger-ui/index.html