Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Mock API #23

Merged
merged 19 commits into from
Jun 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
9b1e910
feat: ๋กœ๊ทธ์ธ, ๋กœ๊ทธ์•„์›ƒ ๋ชฉ ์ปจํŠธ๋กค๋Ÿฌ
devmizz Jun 15, 2024
e632b38
feat: ์•„ํ‹ฐ์ŠคํŠธ ๊ตฌ๋… ๋ชฉ ์ปจํŠธ๋กค๋Ÿฌ
devmizz Jun 15, 2024
1723380
feat: ์Šค์›จ๊ฑฐ Authorization ์„ค์ •
devmizz Jun 15, 2024
9565d97
feat: ์œ ์ € ๋กœ๊ทธ์ธ ์š”์ฒญ ๋ณ€๊ฒฝ
devmizz Jun 15, 2024
5d9bff6
feat: ์œ ์ € ๋กœ๊ทธ์ธ ์š”์ฒญ ๋ณ€๊ฒฝ
devmizz Jun 15, 2024
3b328dd
feat: ์žฅ๋ฅด ๊ตฌ๋… ๋ชฉ ์ปจํŠธ๋กค๋Ÿฌ
devmizz Jun 15, 2024
130697f
refactor: api ๋ชจ๋“ˆ ๊ตฌ์กฐ ๋ณ€๊ฒฝ
devmizz Jun 15, 2024
eade3af
feat: ๊ณต์—ฐ ๊ด€์‹ฌ ๋“ฑ๋ก / ์ทจ์†Œ
devmizz Jun 15, 2024
f211b42
refactor: ํŒจํ‚ค์ง€ ๊ตฌ์กฐ ๋ณ€๊ฒฝ
devmizz Jun 16, 2024
fe42075
feat: ์•„ํ‹ฐ์ŠคํŠธ ๋ชฉ๋ก ์กฐํšŒ
devmizz Jun 16, 2024
1a77a86
feat: ์žฅ๋ฅด ๋ชฉ๋ก ์ปจํŠธ๋กค๋Ÿฌ
devmizz Jun 16, 2024
880b104
feat: ๊ณต์—ฐ ๋ชฉ๋ก ์ปจํŠธ๋กค๋Ÿฌ
devmizz Jun 16, 2024
ba7d048
feat: ๊ด€์‹ฌ ๊ณต์—ฐ ๋ชฉ๋ก ์กฐํšŒ ์ปจํŠธ๋กค๋Ÿฌ
devmizz Jun 16, 2024
2402b36
feat: ๊ณต์—ฐ ์•Œ๋ฆผ ์„ค์ •
devmizz Jun 16, 2024
eaa05bd
feat: ๊ณต์—ฐ ์ƒ์„ธ ์กฐํšŒ
devmizz Jun 16, 2024
0765130
feat: ๊ณต์—ฐ ๊ด€์‹ฌ, ์•Œ๋ฆผ ๋ณ€๊ฒฝ
devmizz Jun 16, 2024
ca0416a
feat: ๊ณต์—ฐ ์•Œ๋ฆผ ์„ค์ •
devmizz Jun 16, 2024
2cf4c2c
feat: PR ๋ฆฌ๋ทฐ 1์ฐจ ๋ฐ˜์˜
devmizz Jun 18, 2024
cab0f1c
feat: Mapping ์•ž์— / ์ถ”๊ฐ€
devmizz Jun 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions app/api/build.gradle
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
bootJar.enabled = false
jar.enabled = true

allprojects {
bootJar.enabled = false
jar.enabled = true

dependencies {
implementation project(":app:domain:common-domain")

Expand All @@ -17,5 +17,7 @@ allprojects {
}

dependencies {
// for config registry
implementation project(":app:api:user-api")
implementation project(":app:api:show-api")
}
3 changes: 0 additions & 3 deletions app/api/common-api/build.gradle
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
bootJar.enabled = false
jar.enabled = true

dependencies {
implementation project(":app:domain:user-domain")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import org.example.filter.JWTFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
Expand All @@ -31,11 +32,37 @@ public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Excepti
corsConfigurationSource()))
.formLogin(AbstractHttpConfigurer::disable)
.httpBasic(AbstractHttpConfigurer::disable)
.sessionManagement(configurer -> configurer.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
.sessionManagement(
configurer -> configurer.sessionCreationPolicy(SessionCreationPolicy.STATELESS)
)
.authorizeHttpRequests(registry ->
registry
.requestMatchers("swagger-ui/**", "/v3/api-docs/**").permitAll()
.anyRequest().permitAll()
.requestMatchers(
"swagger-ui/**", "/v3/api-docs/**",
GaBaljaintheroom marked this conversation as resolved.
Show resolved Hide resolved
"api/v1/users/login"
).permitAll()
.requestMatchers(
HttpMethod.GET,
"api/v1/artists",
"api/v1/genres",
"api/v1/shows"
).permitAll()
.requestMatchers(
HttpMethod.GET,
"api/v1/shows/interests"
).hasAnyRole("USER", "ADMIN")
.requestMatchers(
HttpMethod.POST,
"api/v1/users/logout",
"api/v1/shows/**/interest",
"api/v1/shows/**/alert"
).hasAnyRole("USER", "ADMIN")
.requestMatchers(
HttpMethod.POST,
"api/v1/artists",
"api/v1/genres",
"api/v1/shows"
).hasRole("ADMIN")
)
.addFilterBefore(jwtFilter, UsernamePasswordAuthenticationFilter.class)
.addFilterBefore(exceptionHandlerFilter, JWTFilter.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,27 @@
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {

private final String securitySchemeName = "JWT Authorization";

@Bean
public OpenAPI openAPI() {
return new OpenAPI()
.components(new Components())
.info(getInfo());
.info(getInfo())
.addSecurityItem(getSecurityRequirement())
.components(
new Components().addSecuritySchemes(
securitySchemeName,
getSecurityScheme()
)
);
}

private Info getInfo() {
Expand All @@ -25,6 +35,19 @@ private Info getInfo() {
.license(getLicense());
}

private SecurityRequirement getSecurityRequirement() {
return new SecurityRequirement().addList(securitySchemeName);
}

private SecurityScheme getSecurityScheme() {
return new SecurityScheme()
.name(securitySchemeName)
.type(SecurityScheme.Type.HTTP)
.in(SecurityScheme.In.HEADER)
.scheme("Bearer")
.bearerFormat("JWT");
}

private License getLicense() {
return new License()
.name("Apache 2.0")
Expand Down
3 changes: 3 additions & 0 deletions app/api/show-api/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dependencies {
implementation project(':app:api:common-api')
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package com.example.artist.controller;

import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequiredArgsConstructor
@Tag(name = "์–ด๋“œ๋ฏผ")
GaBaljaintheroom marked this conversation as resolved.
Show resolved Hide resolved
public class ArtistAdminController {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package com.example.artist.controller;

import com.example.artist.controller.dto.request.ArtistPaginationApiRequest;
import com.example.artist.controller.dto.request.ArtistSubscriptionApiRequest;
import com.example.artist.controller.dto.request.ArtistUnsubscriptionApiRequest;
import com.example.artist.controller.dto.response.ArtistPaginationApiResponse;
import com.example.artist.controller.dto.response.ArtistSimpleApiResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import java.util.List;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/artists")
@Tag(name = "์•„ํ‹ฐ์ŠคํŠธ")
public class ArtistController {

private String image = "https://thumb.mtstarnews.com/06/2023/06/2023062914274537673_1.jpg";

@GetMapping
@Operation(summary = "์•„ํ‹ฐ์ŠคํŠธ ๋ชฉ๋ก ์กฐํšŒ")
public ResponseEntity<ArtistPaginationApiResponse> getArtists(
@RequestParam(required = false) ArtistPaginationApiRequest param
) {
return ResponseEntity.ok(
new ArtistPaginationApiResponse(
List.of(
new ArtistSimpleApiResponse(
UUID.randomUUID(),
"์œˆํ„ฐ",
image
)
),
false
)
);
}

@PostMapping("/subscribe")
@Operation(summary = "๊ตฌ๋…ํ•˜๊ธฐ")
public ResponseEntity<Void> bulkSubscribe(
@Valid @RequestBody ArtistSubscriptionApiRequest request
) {
return ResponseEntity.noContent().build();
}

@PostMapping("/unsubscribe")
@Operation(summary = "๊ตฌ๋… ์ทจ์†Œํ•˜๊ธฐ")
public ResponseEntity<Void> unsubscribe(
@Valid @RequestBody ArtistUnsubscriptionApiRequest request
) {
return ResponseEntity.noContent().build();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package com.example.artist.controller.dto.request;

import io.swagger.v3.oas.annotations.Parameter;
import java.util.UUID;
import org.example.pagination.vo.SortDirection;
import org.springdoc.core.annotations.ParameterObject;

@ParameterObject
public record ArtistPaginationApiRequest(

@Parameter(description = "๊ฒ€์ƒ‰์–ด")
String search,

@Parameter(description = "์ •๋ ฌ ๋ฐฉํ–ฅ")
SortDirection sortDirection,

@Parameter(description = "์ด์ „ ํŽ˜์ด์ง€๋„ค์ด์…˜ ๋งˆ์ง€๋ง‰ ๋ฐ์ดํ„ฐ์˜ ID / ์ตœ์ดˆ ์กฐํšŒ๋ผ๋ฉด null")
UUID cursor
) {

public ArtistPaginationApiRequest {
if (sortDirection == null) {
sortDirection = SortDirection.DESC;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package com.example.artist.controller.dto.request;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotEmpty;
import java.util.List;
import java.util.UUID;

public record ArtistSubscriptionApiRequest(
GaBaljaintheroom marked this conversation as resolved.
Show resolved Hide resolved
@Schema(description = "์•„ํ‹ฐ์ŠคํŠธ ID ๋ชฉ๋ก")
@NotEmpty(message = "์•„ํ‹ฐ์ŠคํŠธ ID๋Š” ์ตœ์†Œ ํ•˜๋‚˜ ์ด์ƒ ์ž…๋ ฅํ•ด์•ผํ•ฉ๋‹ˆ๋‹ค.")
List<UUID> artistIds
) {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.example.artist.controller.dto.request;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotEmpty;
import java.util.List;
import java.util.UUID;

public record ArtistUnsubscriptionApiRequest(

@Schema(description = "์•„ํ‹ฐ์ŠคํŠธ ID ๋ชฉ๋ก")
@NotEmpty(message = "์•„ํ‹ฐ์ŠคํŠธ ID๋Š” ์ตœ์†Œ ํ•˜๋‚˜ ์ด์ƒ ์ž…๋ ฅํ•ด์•ผํ•ฉ๋‹ˆ๋‹ค.")
List<UUID> artistIds
) {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.example.artist.controller.dto.response;

import io.swagger.v3.oas.annotations.media.Schema;
import java.util.List;

public record ArtistPaginationApiResponse(

@Schema(description = "์•„ํ‹ฐ์ŠคํŠธ ๋ชฉ๋ก")
List<ArtistSimpleApiResponse> artists,

@Schema(description = "๋‹ค์Œ ํŽ˜์ด์ง€ ์กด์žฌ ์—ฌ๋ถ€")
boolean hasNext
) {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package com.example.artist.controller.dto.response;

import io.swagger.v3.oas.annotations.media.Schema;
import java.util.UUID;

public record ArtistSimpleApiResponse(

@Schema(description = "์•„ํ‹ฐ์ŠคํŠธ ID")
UUID id,

@Schema(description = "์•„ํ‹ฐ์ŠคํŠธ ์ด๋ฆ„")
String name,

@Schema(description = "์•„ํ‹ฐ์ŠคํŠธ ์ด๋ฏธ์ง€ ์ฃผ์†Œ")
String image
) {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package com.example.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan(basePackages = "com.example")
public class ShowApiConfig {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package com.example.genre.controller;

import org.springframework.web.bind.annotation.RestController;

@RestController
public class GenreAdminController {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
package com.example.genre.controller;

import com.example.genre.controller.dto.request.GenrePaginationApiRequest;
import com.example.genre.controller.dto.request.GenreSubscriptionApiRequest;
import com.example.genre.controller.dto.request.GenreUnsubscriptionApiRequest;
import com.example.genre.controller.dto.response.GenrePaginationApiResponse;
import com.example.genre.controller.dto.response.GenreSimpleApiResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import java.util.List;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/genres")
@Tag(name = "์žฅ๋ฅด")
public class GenreController {

@GetMapping
@Operation(summary = "์žฅ๋ฅด ๋ชฉ๋ก ์กฐํšŒ")
public ResponseEntity<GenrePaginationApiResponse> getGenres(
@RequestParam(required = false) GenrePaginationApiRequest param
) {
String image = "https://thumb.mtstarnews.com/06/2023/06/2023062914274537673_1.jpg";
return ResponseEntity.ok(
new GenrePaginationApiResponse(
List.of(
new GenreSimpleApiResponse(
UUID.randomUUID(),
"ํž™ํ•ฉ",
image
),
new GenreSimpleApiResponse(
UUID.randomUUID(),
"๋ฐœ๋ผ๋“œ",
image
),
new GenreSimpleApiResponse(
UUID.randomUUID(),
"์‹œํ‹ฐํŒ",
image
)
),
false
)
);
}

@PostMapping("/subscribe")
@Operation(summary = "๊ตฌ๋…ํ•˜๊ธฐ")
public ResponseEntity<Void> subscribe(
@Valid @RequestBody GenreSubscriptionApiRequest request
) {
return ResponseEntity.noContent().build();
}

@PostMapping("/unsubscribe")
@Operation(summary = "๊ตฌ๋… ์ทจ์†Œํ•˜๊ธฐ")
public ResponseEntity<Void> unsubscribe(
@Valid @RequestBody GenreUnsubscriptionApiRequest request
) {
return ResponseEntity.noContent().build();
}
}
Loading