swagger (springdoc-openapi)

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

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.9'

import org.springframework.context.annotation.Configuration;

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;

@Configuration
@OpenAPIDefinition(
    info = @Info(title = "에이~피~아이", version = "1.0", description = "함 해보자~")
)
public class SwaggerConfig {

}

config 결과 화면

 

class @Tag(name = "게시판 API", description = "게시판 관련 API입니다.")

@Tag 결과 화면

 

method @Operation(summary = "게시판 목록", description = "게시판 목록 입니다.")

@Operation 결과 화면

 

@ParameterObject , @Parameter(name = "", description = "", example = "")

	@PostMapping("/board/save")
	//public Boolean boardSave(@RequestBody Board board) {		//axios, json
	public Boolean boardSave(@ParameterObject Board board) {	//swagger
		Boolean result = boardService.save(board);
		return result;
	}

@ParameterObject 결과 화면

	@PostMapping("/board/save")
	public Boolean boardSave(@RequestBody Board board) {		//axios, json
	//public Boolean boardSave(@ParameterObject Board board) {	//swagger
		Boolean result = boardService.save(board);
		return result;
	}

@RequestBody 결과 화면