Skip to content

Commit

Permalink
Merge pull request #297 from Team-Sopetit/fix/#296-docs-file
Browse files Browse the repository at this point in the history
[FIX] docs 파일명 변경
  • Loading branch information
thguss authored Jun 25, 2024
2 parents 31cf45a + fba5510 commit cc883a3
Show file tree
Hide file tree
Showing 27 changed files with 45 additions and 206 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.soptie.server.auth.controller.docs.AuthControllerDocs;
import com.soptie.server.auth.controller.dto.request.SignInRequest;
import com.soptie.server.auth.controller.dto.response.SignInResponse;
import com.soptie.server.auth.controller.dto.response.TokenGetResponse;
Expand All @@ -28,7 +29,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/auth")
public class AuthController implements AuthApi {
public class AuthController implements AuthControllerDocs {

private final AuthService authService;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.soptie.server.auth.controller;
package com.soptie.server.auth.controller.docs;

import java.security.Principal;

Expand All @@ -21,7 +21,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "auth", description = "인증 API")
public interface AuthApi {
public interface AuthControllerDocs {

@Operation(
summary = "소셜 로그인",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import org.springframework.web.bind.annotation.RestController;

import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.doll.controller.docs.DollControllerDocs;
import com.soptie.server.doll.dto.DollImageResponse;
import com.soptie.server.doll.entity.DollType;
import com.soptie.server.doll.service.DollService;
Expand All @@ -20,7 +21,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/dolls")
public class DollController implements DollApi {
public class DollController implements DollControllerDocs {

private final DollService dollService;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.soptie.server.doll.controller;
package com.soptie.server.doll.controller.docs;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
Expand All @@ -17,7 +17,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "dolls", description = "애착 인형 API")
public interface DollApi {
public interface DollControllerDocs {

@Operation(
summary = "인형 이미지 불러오기",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

import com.soptie.server.common.dto.BaseResponse;
import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.member.controller.docs.MemberApi;
import com.soptie.server.member.controller.docs.MemberControllerDocs;
import com.soptie.server.member.controller.dto.request.MemberProfileCreateRequest;
import com.soptie.server.member.controller.dto.response.MemberCottonCountGetResponse;
import com.soptie.server.member.controller.dto.response.MemberHomeInfoGetResponse;
Expand All @@ -33,7 +33,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("api/v1/members")
public class MemberController implements MemberApi {
public class MemberController implements MemberControllerDocs {

private final MemberService memberService;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "members", description = "회원 API")
public interface MemberApi {
public interface MemberControllerDocs {

@Operation(
summary = "멤버 프로필 생성",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import com.soptie.server.common.dto.BaseResponse;
import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.common.support.UriGenerator;
import com.soptie.server.memberroutine.controller.v1.docs.MemberDailyRoutineApi;
import com.soptie.server.memberroutine.controller.v1.docs.MemberDailyRoutineControllerDocs;
import com.soptie.server.memberroutine.controller.v1.dto.request.MemberDailyRoutineCreateRequest;
import com.soptie.server.memberroutine.controller.v1.dto.response.MemberDailyRoutineAchieveResponse;
import com.soptie.server.memberroutine.controller.v1.dto.response.MemberDailyRoutineCreateResponse;
Expand All @@ -40,7 +40,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/routines/daily/member")
public class MemberDailyRoutineController implements MemberDailyRoutineApi {
public class MemberDailyRoutineController implements MemberDailyRoutineControllerDocs {

private final MemberRoutineCreateService memberRoutineCreateService;
private final MemberRoutineReadService memberRoutineReadService;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import com.soptie.server.common.dto.BaseResponse;
import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.common.support.UriGenerator;
import com.soptie.server.memberroutine.controller.v1.docs.MemberHappinessRoutineApi;
import com.soptie.server.memberroutine.controller.v1.docs.MemberHappinessRoutineControllerDocs;
import com.soptie.server.memberroutine.controller.v1.dto.request.MemberHappinessRoutineRequest;
import com.soptie.server.memberroutine.controller.v1.dto.response.MemberHappinessRoutineCreateResponse;
import com.soptie.server.memberroutine.controller.v1.dto.response.MemberHappinessRoutineGetResponse;
Expand All @@ -37,7 +37,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/routines/happiness/member")
public class MemberHappinessRoutineController implements MemberHappinessRoutineApi {
public class MemberHappinessRoutineController implements MemberHappinessRoutineControllerDocs {

private final MemberRoutineCreateService memberRoutineCreateService;
private final MemberRoutineReadService memberRoutineReadService;
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "member daily routines V1", description = "회원의 데일리 루틴 API Version1")
public interface MemberDailyRoutineApi {
public interface MemberDailyRoutineControllerDocs {

@Operation(
summary = "데일리 루틴 추가",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "member happiness routines V1", description = "회원의 행복 루틴 API Version1")
public interface MemberHappinessRoutineApi {
public interface MemberHappinessRoutineControllerDocs {

@Operation(
summary = "행복 루틴 추가",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import org.springframework.web.bind.annotation.RestController;

import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.memberroutine.controller.v2.docs.MemberDailyRoutineApi;
import com.soptie.server.memberroutine.controller.v2.docs.MemberDailyRoutineControllerV2Docs;
import com.soptie.server.memberroutine.controller.v2.dto.response.MemberDailyRoutineListAcquireResponseV2;
import com.soptie.server.memberroutine.service.MemberRoutineReadService;
import com.soptie.server.memberroutine.service.dto.request.MemberDailyRoutineListAcquireServiceRequest;
Expand All @@ -22,7 +22,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v2/routines/daily/member")
public class MemberDailyRoutineControllerV2 implements MemberDailyRoutineApi {
public class MemberDailyRoutineControllerV2 implements MemberDailyRoutineControllerV2Docs {

private final MemberRoutineReadService memberRoutineReadService;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "member daily routines V2", description = "회원의 데일리 루틴 API Version2")
public interface MemberDailyRoutineApi {
public interface MemberDailyRoutineControllerV2Docs {

@Operation(
summary = "회원의 데일리 루틴 목록 조회",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import org.springframework.web.bind.annotation.RestController;

import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.routine.controller.v1.api.DailyRoutineApiV1;
import com.soptie.server.routine.controller.v1.docs.DailyRoutineControllerDocs;
import com.soptie.server.routine.controller.v1.dto.response.DailyRoutineListByThemeGetResponse;
import com.soptie.server.routine.controller.v1.dto.response.DailyRoutineListByThemesGetResponse;
import com.soptie.server.routine.service.RoutineService;
Expand All @@ -27,7 +27,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/routines/daily")
public class DailyRoutineControllerV1 implements DailyRoutineApiV1 {
public class DailyRoutineController implements DailyRoutineControllerDocs {

private final RoutineService routineService;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import org.springframework.web.bind.annotation.RestController;

import com.soptie.server.common.dto.SuccessResponse;
import com.soptie.server.routine.controller.v1.api.HappinessRoutineApiV1;
import com.soptie.server.routine.controller.v1.docs.HappinessRoutineControllerDocs;
import com.soptie.server.routine.controller.v1.dto.response.HappinessRoutineListGetResponse;
import com.soptie.server.routine.controller.v1.dto.response.HappinessSubRoutineListGetResponse;
import com.soptie.server.routine.service.RoutineService;
Expand All @@ -24,7 +24,7 @@
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/routines/happiness")
public class HappinessRoutineControllerV1 implements HappinessRoutineApiV1 {
public class HappinessRoutineController implements HappinessRoutineControllerDocs {

private final RoutineService routineService;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.soptie.server.routine.controller.v1.api;
package com.soptie.server.routine.controller.v1.docs;

import java.security.Principal;
import java.util.List;
Expand All @@ -21,7 +21,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "daily routines V1", description = "데일리 루틴 API Version1")
public interface DailyRoutineApiV1 {
public interface DailyRoutineControllerDocs {

@Operation(
summary = "테마 목록별 데일리 루틴 목록 조회",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.soptie.server.routine.controller.v1.api;
package com.soptie.server.routine.controller.v1.docs;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
Expand All @@ -18,7 +18,7 @@
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "happiness routines", description = "행복 루틴 API")
public interface HappinessRoutineApiV1 {
public interface HappinessRoutineControllerDocs {

@Operation(
summary = "테마 목록별 행복 루틴 목록 조회",
Expand Down
Loading

0 comments on commit cc883a3

Please sign in to comment.