qkr10 님의 블로그

  • 홈
  • 태그
  • 방명록

OpenAPI 1

[개발기록/CEC 프로젝트] 1. OpenAPI 양식으로 명세서 작성하기

1. 개요1-1. 문제 상황프론트가 화면을 API 와 연동하면서, API 간의 일관성의 부족으로 프론트가 수정 요청하는 상황이 있었다.관리자 웹 API는 어떻게든 수정해서 프론트와 연동을 완료했지만, 사용자 웹 API는 관리자 웹보다도 훨씬 더 일관성이 떨어졌다.문제 사례는 다음과 같다.페이지네이션 공통 응답 DTO 를 사용해야 하는데, JPA Pageable 을 그대로 응답하는 경우가 있었다.모든 API 응답은, status, message, data 필드가 있어야 하는데, 그 규칙을 따르지 않은 경우가 있었다.필드명이 일관성 없는 경우는 너무나 많았다.필요한 API 가 없는 경우도 있었다. (게시글 좋아요 취소 / 조회)당시 사용자 웹 API는 Swagger Editor에서File > Import U..

개발기록/CEC 프로젝트 2025.07.13
이전
1
다음
더보기
프로필사진

qkr10 님의 블로그

qkr10 님의 블로그 입니다.

  • 분류 전체보기 (5)
    • 개발기록 (4)
      • CEC 프로젝트 (4)
      • 티스토리 스킨 (0)
    • 기타 (1)

Tag

rate limit, mockito, Sorted Sets, swagger, API 명세서, HTTP, 픽스처, Junit5, 스프링, 슬라이딩 윈도우, acme, Certbot, 명세서, 횟수 제한, presigned, S3, 스웨거, JWT, Redis, DNS,

최근글과 인기글

  • 최근글
  • 인기글

최근댓글

공지사항

페이스북 트위터 플러그인

  • Facebook
  • Twitter

Archives

Calendar

«   2026/08   »
일 월 화 수 목 금 토
1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31

방문자수Total

  • Today :
  • Yesterday :

Copyright © Daum Corp. All rights reserved.

티스토리툴바