add better swagger docs with examples
Some checks failed
Deploy App / docker (ubuntu-latest, 2.44.0, 17, 3.8.5) (push) Has been cancelled
Some checks failed
Deploy App / docker (ubuntu-latest, 2.44.0, 17, 3.8.5) (push) Has been cancelled
This commit is contained in:
parent
708ccc294d
commit
3bd0ea3838
@ -4,6 +4,7 @@ import cc.fascinated.common.PlayerUtils;
|
||||
import cc.fascinated.model.player.Player;
|
||||
import cc.fascinated.model.player.Skin;
|
||||
import cc.fascinated.service.PlayerService;
|
||||
import io.swagger.v3.oas.annotations.Parameter;
|
||||
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.CacheControl;
|
||||
@ -29,15 +30,21 @@ public class PlayerController {
|
||||
|
||||
@ResponseBody
|
||||
@GetMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
|
||||
public ResponseEntity<?> getPlayer(@PathVariable String id) {
|
||||
public ResponseEntity<?> getPlayer(
|
||||
@Parameter(description = "The UUID or Username of the player", example = "ImFascinated")
|
||||
@PathVariable String id) {
|
||||
return ResponseEntity.ok()
|
||||
.cacheControl(cacheControl)
|
||||
.body(playerManagerService.getPlayer(id));
|
||||
}
|
||||
|
||||
@GetMapping(value = "/{part}/{id}")
|
||||
public ResponseEntity<?> getPlayerHead(@PathVariable String part,
|
||||
public ResponseEntity<?> getPlayerHead(
|
||||
@Parameter(description = "The part of the skin", example = "head")
|
||||
@PathVariable String part,
|
||||
@Parameter(description = "The UUID or Username of the player", example = "ImFascinated")
|
||||
@PathVariable String id,
|
||||
@Parameter(description = "The size of the image", example = "256")
|
||||
@RequestParam(required = false, defaultValue = "256") int size) {
|
||||
Player player = playerManagerService.getPlayer(id);
|
||||
Skin.Parts skinPart = Skin.Parts.fromName(part);
|
||||
|
@ -4,6 +4,8 @@ import cc.fascinated.common.ServerUtils;
|
||||
import cc.fascinated.common.Tuple;
|
||||
import cc.fascinated.model.cache.CachedMinecraftServer;
|
||||
import cc.fascinated.service.ServerService;
|
||||
import io.swagger.v3.oas.annotations.Parameter;
|
||||
import io.swagger.v3.oas.annotations.media.ExampleObject;
|
||||
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
@ -21,14 +23,20 @@ public class ServerController {
|
||||
|
||||
@ResponseBody
|
||||
@GetMapping(value = "/{platform}/{hostnameAndPort}", produces = MediaType.APPLICATION_JSON_VALUE)
|
||||
public CachedMinecraftServer getServer(@PathVariable String platform, @PathVariable String hostnameAndPort) {
|
||||
public CachedMinecraftServer getServer(
|
||||
@Parameter(description = "The platform of the server", example = "java")
|
||||
@PathVariable String platform,
|
||||
@Parameter(description = "The hostname and port of the server", example = "play.hypixel.net")
|
||||
@PathVariable String hostnameAndPort) {
|
||||
Tuple<String, Integer> host = ServerUtils.getHostnameAndPort(hostnameAndPort);
|
||||
return serverService.getServer(platform, host.getLeft(), host.getRight());
|
||||
}
|
||||
|
||||
@ResponseBody
|
||||
@GetMapping(value = "/icon/{hostnameAndPort}", produces = MediaType.APPLICATION_JSON_VALUE)
|
||||
public ResponseEntity<?> getServerIcon(@PathVariable String hostnameAndPort) {
|
||||
public ResponseEntity<?> getServerIcon(
|
||||
@Parameter(description = "The hostname and port of the server", example = "play.hypixel.net")
|
||||
@PathVariable String hostnameAndPort) {
|
||||
Tuple<String, Integer> host = ServerUtils.getHostnameAndPort(hostnameAndPort);
|
||||
String hostname = host.getLeft();
|
||||
int port = host.getRight();
|
||||
|
Loading…
Reference in New Issue
Block a user