기타

Spring Boot 업무 API

화면과 외부 시스템이 함께 쓰는 업무 API를, 권한과 예외 처리까지 포함해 개발합니다.

유형
Spring Boot 업무 API
버전
v0.1.0
예시 · 준비 중
최근 수정 2026-09-17
예상 기간
3~6주

SPEC

기술 스펙

서버
  • Java 17
  • Spring Boot
  • MyBatis
데이터
  • PostgreSQL

FIT

이런 프로젝트에 맞습니다

  • 화면과 외부 시스템이 같은 업무 데이터를 함께 써야 하는 경우
  • 기존 API가 권한·예외 처리 기준 없이 늘어난 경우
  • 연동 규격을 문서로 넘겨야 하는 경우

PREBUILT

예시로 살펴볼 구성

아래는 예시에서 다루는 구성입니다. 실제 템플릿의 기능과 제공 범위는 제작·검증을 거쳐 확정할 예정입니다.

인증·권한 계층
로그인, 토큰 검증, 역할별 접근 제어가 동작하는 상태로 준비되어 있습니다.
표준 응답·예외 형식
성공·실패 응답 형식과 오류 코드 체계가 정해져 있어 화면 쪽 처리 기준이 흔들리지 않습니다.
목록·상세·등록 기본 구조
조회, 상세, 등록·수정·삭제와 페이징·정렬이 같은 규칙으로 동작합니다.
API 문서 자동 생성
코드에서 연동 규격 문서를 뽑아내는 설정이 들어 있어 문서를 따로 관리하지 않습니다.

프로젝트에 맞춰 구성과 디자인을 조정합니다.

SCREENS

예시 화면

구성과 화면 흐름을 참고하기 위한 예시입니다. 최종 템플릿의 디자인과 스타일은 아직 확정되지 않았습니다.

제목·설명·제공기관 등 메타정보와 데이터타입·URL·실행 주기 입력란이 있는 연계 등록 화면.
외부 연계 등록 화면 · 메타정보와 호출 주기를 입력하고 응답 데이터를 바로 확인합니다.

SCOPE

포함 범위

결과물

  • 합의한 범위의 REST API
  • API 규격 문서
  • 테스트 코드와 실행 결과

포함 범위

  • 도메인과 업무 규칙 정리
  • API 설계와 구현, 권한 처리
  • 데이터베이스 스키마 반영과 조회 최적화
  • 검수 기준에 따른 동작 확인과 1회 수정

제외 범위

  • 화면(프런트엔드) 전체 개발
  • 기존 레거시 시스템 전면 이관
  • 운영 서버 상시 관제
  • 외부 상용 솔루션 라이선스

제공 범위와 제외 범위를 먼저 정의한 뒤 진행합니다. 일정과 세부 조건은 협의 후 SOW에서 확정합니다.

이 서비스가 해결하는 문제

화면마다 데이터 처리 방식이 다르면 같은 업무인데 결과가 달라집니다. 업무 규칙을 API에 모으면 화면과 외부 시스템이 같은 기준을 사용하게 됩니다.

진행 방식

  1. 도메인, 업무 규칙과 권한 기준을 확인합니다.
  2. API 목록, 요청·응답 규격과 검수 기준을 SOW로 확정합니다.
  3. API를 구현하고 테스트 코드로 동작을 확인합니다.
  4. 규격 문서와 함께 전달하고 검수합니다.

범위와 추가 개발의 구분

SOW의 API가 규격대로 동작하지 않으면 하자입니다. 새 엔드포인트, 새 업무 규칙, 새 연계 시스템은 추가 개발로 보고 별도 견적을 냅니다.

FAQ

자주 묻는 질문

기존 데이터베이스 구조를 그대로 써야 하나요?
기존 구조를 우선 사용합니다. 변경이 필요하면 영향 범위를 먼저 확인하고 SOW에 반영합니다.
Java 버전이나 프레임워크 버전을 지정할 수 있나요?
운영 환경에 맞춰 지정할 수 있습니다. 지정한 버전은 SOW의 기술환경 항목에 기록합니다.

필요한 구성이 있으신가요?

필요한 화면과 연동 범위를 알려주시면 가능한 범위를 정리해 회신합니다.

이 구성으로 문의하기