Swagger @Tag Anotasyonu

Giriş

Şu satırı dahil ederiz

import io.swagger.v3.oas.annotations.tags.Tag;

Açıklaması şöyle

In springfox implementation this tag represents the equivalent of the tag @Api

name Alanı

Örnek

Şöyle yaparız. Burada @Tags içinde @Tag anotasyonları var

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.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;

import java.util.Arrays;
import java.util.List;

@RestController
@Tags(value = {@Tag(name = "User")})
public class UserController {

  @GetMapping("/users")
  @Tags(value = {@Tag(name = "User")})
  @Operation(
    summary = "Get Users",
    description = "Get Users",
    responses = {@ApiResponse(
      responseCode = "200",
      content = {@Content(mediaType = "application/json")}
     )}
   )
  public List<User> getUsers() {
    ...
  }
  ...
}

Örnek

Şöyle yaparız. Aynı Tag değeri @Operation içinde kullanılabilir.

@RestController
@RequestMapping("/people")
@Tag(name = "People", description = "Endpoints for managing people")
public class PersonController {
  ...
}