defined all players endpoint in oas, implemented method to get all players filtered and paginated (not done)
This commit is contained in:
parent
b22ffd0cfa
commit
99241ba25b
7 changed files with 111 additions and 23 deletions
api
src
main/java/de/towerdefence/server
test/java/de/towerdefence/server
43
api/api.yml
43
api/api.yml
|
@ -65,10 +65,10 @@ components:
|
||||||
description: a Player
|
description: a Player
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
name:
|
username:
|
||||||
type: string
|
type: string
|
||||||
required:
|
required:
|
||||||
- name
|
- username
|
||||||
responses:
|
responses:
|
||||||
201PlayerCreated:
|
201PlayerCreated:
|
||||||
description: "201 - Player Created"
|
description: "201 - Player Created"
|
||||||
|
@ -162,9 +162,46 @@ paths:
|
||||||
/admin/players:
|
/admin/players:
|
||||||
get:
|
get:
|
||||||
operationId: "GetAllPlayers"
|
operationId: "GetAllPlayers"
|
||||||
|
summary: "Retrieve a paginated list of players"
|
||||||
|
description: "Returns a paginated list of players, optionally filtered by username."
|
||||||
|
parameters:
|
||||||
|
- name: page
|
||||||
|
in: query
|
||||||
|
description: "Page number (zero-based index)."
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
default: 0
|
||||||
|
- name: pageSize
|
||||||
|
in: query
|
||||||
|
description: "Number of players per page."
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
default: 10
|
||||||
|
- name: sortBy
|
||||||
|
in: query
|
||||||
|
description: "Field to sort by (default is username)."
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
default: "username"
|
||||||
|
- name: order
|
||||||
|
in: query
|
||||||
|
description: "Sorting order (asc or desc)."
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
enum: [asc, desc]
|
||||||
|
default: "asc"
|
||||||
|
- name: username
|
||||||
|
in: query
|
||||||
|
description: "Filter players by username (case-insensitive, partial match)."
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
tags:
|
tags:
|
||||||
- admin
|
- admin
|
||||||
description: 'Endpoint for getting all players'
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "A List of all Player"
|
description: "A List of all Player"
|
||||||
|
|
|
@ -16,9 +16,7 @@ import org.springframework.data.domain.Pageable;
|
||||||
import org.springframework.data.domain.Sort;
|
import org.springframework.data.domain.Sort;
|
||||||
import org.springframework.http.ResponseEntity;
|
import org.springframework.http.ResponseEntity;
|
||||||
import org.springframework.stereotype.Controller;
|
import org.springframework.stereotype.Controller;
|
||||||
import org.springframework.web.bind.annotation.GetMapping;
|
|
||||||
import org.springframework.web.bind.annotation.RequestMapping;
|
import org.springframework.web.bind.annotation.RequestMapping;
|
||||||
import org.springframework.web.bind.annotation.RequestParam;
|
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
@ -54,25 +52,17 @@ public class AdminApiController implements AdminApi {
|
||||||
return ResponseEntity.ok(authInfo);
|
return ResponseEntity.ok(authInfo);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
@GetMapping("/admin/players")
|
public ResponseEntity<List<PlayerApiModel>> getAllPlayers(Integer page, Integer pageSize, String sortBy, String order, String username) {
|
||||||
public ResponseEntity<List<PlayerApiModel>> getAllPlayers(
|
Sort.Direction direction = order.equalsIgnoreCase("asc") ? Sort.Direction.ASC : Sort.Direction.DESC;
|
||||||
@RequestParam(value = "page", required = false, defaultValue = "0") int page,
|
|
||||||
@RequestParam(value = "pageSize", required = false, defaultValue = "10") int pageSize,
|
|
||||||
@RequestParam(value = "sortBy", required = false, defaultValue = "name") String sortBy,
|
|
||||||
@RequestParam(value = "order", required = false, defaultValue = "asc") String order,
|
|
||||||
@RequestParam(value = "name", required = false) String name) {
|
|
||||||
|
|
||||||
Sort.Direction direction = order.equalsIgnoreCase("desc") ? Sort.Direction.DESC : Sort.Direction.ASC;
|
|
||||||
Pageable pageable = PageRequest.of(page, pageSize, Sort.by(direction, sortBy));
|
Pageable pageable = PageRequest.of(page, pageSize, Sort.by(direction, sortBy));
|
||||||
|
|
||||||
Page<Player> playerPage = (name != null && !name.trim().isEmpty())
|
Page<Player> playerPage = (username != null && !username.trim().isEmpty())
|
||||||
? playerRepository.findByNameContainingIgnoreCase(name, pageable)
|
? playerRepository.findByUsernameContainingIgnoreCase(username, pageable)
|
||||||
: playerRepository.findAll(pageable);
|
: playerRepository.findAll(pageable);
|
||||||
|
|
||||||
List<PlayerApiModel> playersMapped = playerMapperService.mapPlayerToApiPlayers(playerPage.getContent());
|
List<PlayerApiModel> playersMapped = playerMapperService.mapPlayerToApiPlayers(playerPage.getContent());
|
||||||
|
|
||||||
return playersMapped.isEmpty() ? ResponseEntity.noContent().build() : ResponseEntity.ok(playersMapped);
|
return playersMapped.isEmpty() ? ResponseEntity.noContent().build() : ResponseEntity.ok(playersMapped);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -7,5 +7,5 @@ import org.springframework.data.jpa.repository.JpaRepository;
|
||||||
public interface PlayerRepository extends JpaRepository<Player, Long> {
|
public interface PlayerRepository extends JpaRepository<Player, Long> {
|
||||||
Player findByUsername(String username);
|
Player findByUsername(String username);
|
||||||
boolean existsByUsername(String username);
|
boolean existsByUsername(String username);
|
||||||
Page<Player> findByNameContainingIgnoreCase(String name, Pageable pageable);
|
Page<Player> findByUsernameContainingIgnoreCase(String username, Pageable pageable);
|
||||||
}
|
}
|
||||||
|
|
|
@ -14,7 +14,7 @@ public class PlayerMapperService {
|
||||||
List<PlayerApiModel> apiPlayers = new ArrayList<>();
|
List<PlayerApiModel> apiPlayers = new ArrayList<>();
|
||||||
for (Player player : players) {
|
for (Player player : players) {
|
||||||
PlayerApiModel apiPlayer = new PlayerApiModel();
|
PlayerApiModel apiPlayer = new PlayerApiModel();
|
||||||
apiPlayer.setName(player.getUsername());
|
apiPlayer.setUsername(player.getUsername());
|
||||||
}
|
}
|
||||||
return apiPlayers;
|
return apiPlayers;
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
package de.towerdefence.server;
|
package de.towerdefence.server;
|
||||||
|
|
||||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import de.towerdefence.server.player.Player;
|
||||||
import de.towerdefence.server.player.PlayerRepository;
|
import de.towerdefence.server.player.PlayerRepository;
|
||||||
import de.towerdefence.server.player.PlayerService;
|
import de.towerdefence.server.player.PlayerService;
|
||||||
import org.junit.jupiter.api.AfterEach;
|
import org.junit.jupiter.api.AfterEach;
|
||||||
|
@ -11,6 +12,8 @@ import org.springframework.boot.test.context.SpringBootTest;
|
||||||
import org.springframework.test.context.ActiveProfiles;
|
import org.springframework.test.context.ActiveProfiles;
|
||||||
import org.springframework.test.web.servlet.MockMvc;
|
import org.springframework.test.web.servlet.MockMvc;
|
||||||
|
|
||||||
|
import java.security.NoSuchAlgorithmException;
|
||||||
|
|
||||||
@SpringBootTest
|
@SpringBootTest
|
||||||
@AutoConfigureMockMvc(addFilters = false)
|
@AutoConfigureMockMvc(addFilters = false)
|
||||||
@ActiveProfiles("test")
|
@ActiveProfiles("test")
|
||||||
|
@ -24,10 +27,22 @@ public abstract class IntegrationTest {
|
||||||
protected ObjectMapper objectMapper;
|
protected ObjectMapper objectMapper;
|
||||||
@Autowired
|
@Autowired
|
||||||
protected PlayerRepository playerRepository;
|
protected PlayerRepository playerRepository;
|
||||||
|
@Autowired
|
||||||
|
protected PlayerService playerService;
|
||||||
|
|
||||||
@BeforeEach
|
@BeforeEach
|
||||||
void setUp() {
|
void setUp() {
|
||||||
playerRepository.deleteAll();
|
playerRepository.deleteAll();
|
||||||
|
|
||||||
|
Player player1 = new Player();
|
||||||
|
player1.setUsername("Player1");
|
||||||
|
try {
|
||||||
|
playerService.setPassword(player1, "1234");
|
||||||
|
} catch (NoSuchAlgorithmException e) {return;}
|
||||||
|
|
||||||
|
this.playerRepository.save(player1);
|
||||||
|
|
||||||
|
System.out.println("LISTE: " + playerRepository.findAll());
|
||||||
}
|
}
|
||||||
|
|
||||||
@AfterEach
|
@AfterEach
|
||||||
|
|
|
@ -0,0 +1,48 @@
|
||||||
|
package de.towerdefence.server.server;
|
||||||
|
|
||||||
|
import de.towerdefence.server.IntegrationTest;
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.springframework.http.MediaType;
|
||||||
|
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
|
||||||
|
|
||||||
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||||
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
|
||||||
|
|
||||||
|
class GetAllPlayersPaginatedAndSortedTest extends IntegrationTest {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void testGetAllPlayersPaginatedAndSorted() throws Exception {
|
||||||
|
this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
|
||||||
|
.param("page", "0")
|
||||||
|
.param("pageSize", "10")
|
||||||
|
.param("sortBy", "username")
|
||||||
|
.param("order", "desc")
|
||||||
|
.contentType(MediaType.APPLICATION_JSON))
|
||||||
|
.andExpect(status().isOk())
|
||||||
|
.andExpect(jsonPath("$").isArray())
|
||||||
|
.andExpect(jsonPath("$[0]").exists());
|
||||||
|
|
||||||
|
this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
|
||||||
|
.param("page", "0")
|
||||||
|
.param("pageSize", "10")
|
||||||
|
.param("sortBy", "username")
|
||||||
|
.param("order", "asc")
|
||||||
|
.contentType(MediaType.APPLICATION_JSON))
|
||||||
|
.andExpect(status().isOk())
|
||||||
|
.andExpect(jsonPath("$[0].name").value("A"))
|
||||||
|
.andExpect(jsonPath("$[9].name").value("Z"));
|
||||||
|
|
||||||
|
/*
|
||||||
|
testing if specific username that is being filtered by is in the result list
|
||||||
|
this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
|
||||||
|
.param("page", "0")
|
||||||
|
.param("pageSize", "10")
|
||||||
|
.param("username", "John")
|
||||||
|
.contentType(MediaType.APPLICATION_JSON))
|
||||||
|
.andExpect(status().isOk())
|
||||||
|
.andExpect(jsonPath("$").isArray())
|
||||||
|
.andExpect(jsonPath("$[0].name").value("John"))
|
||||||
|
.andExpect(jsonPath("$").isNotEmpty());
|
||||||
|
*/
|
||||||
|
}
|
||||||
|
}
|
|
@ -30,6 +30,4 @@ public class PlayerRegistrationTest extends IntegrationTest {
|
||||||
.content(this.objectMapper.writeValueAsString(playerRegistrationData))
|
.content(this.objectMapper.writeValueAsString(playerRegistrationData))
|
||||||
.contentType(MediaType.APPLICATION_JSON);
|
.contentType(MediaType.APPLICATION_JSON);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Reference in a new issue