mirror of
https://github.com/nagisa77/OpenIsle.git
synced 2026-02-14 02:50:58 +08:00
doc: add OpenAPI annotations to remaining controllers
This commit is contained in:
@@ -1,5 +1,10 @@
|
||||
package com.openisle.controller;
|
||||
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
import io.swagger.v3.oas.annotations.media.Content;
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import io.swagger.v3.oas.annotations.responses.ApiResponse;
|
||||
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
import java.util.Map;
|
||||
@@ -7,6 +12,10 @@ import java.util.Map;
|
||||
@RestController
|
||||
public class HelloController {
|
||||
@GetMapping("/api/hello")
|
||||
@SecurityRequirement(name = "JWT")
|
||||
@Operation(summary = "Hello endpoint", description = "Returns a greeting for authenticated users")
|
||||
@ApiResponse(responseCode = "200", description = "Greeting payload",
|
||||
content = @Content(schema = @Schema(implementation = Map.class)))
|
||||
public Map<String, String> hello() {
|
||||
return Map.of("message", "Hello, Authenticated User");
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user