개발/Swagger

Swagger에서 ApiOkResponse(), ApiOperation(), ApiTags()의 역할

Zaein 2023. 4. 5. 16:38

ApiOkResponse()

Swagger 데코레이터

성공적인 API 호출(200)에 대한 응답을 정의함

 

 

ApiOperation()

Swagger 데코레이터

API 엔드포인트에(Get,Post,Put,Delete) 대한 메타정보를 제공함

*메타정보: API의 설명, 요청 및 응답 페이로드, 성공/실패 상태 코드 및 예외처리

 

 

ApiTags()

Swagger 데코레이터

API를 그룹화 하는 태그를 지정함

Swagger UI에서 그룹으로 API 검색 가능

'개발 > Swagger' 카테고리의 다른 글

Swagger에서 ApiBody(), ApiCreatedResponse()의 역할  (0) 2023.04.05