Fast API - 라우팅 데코레이터의 속성

라우팅 데코레이터에는 기존에 라우팅을 하는 문자열 뿐만 아니라 여러가지의 속성이 들어가 추가적인 기능을 할 수 있게 설정할 수 있다.

이 속성들에 대해서 간단하게 필요한것들만 알아보자.

 

1. tags

라우팅 데코레이터 중 tags라는 속성은 문서에서 엔드 포인트들을 직접설정해서 하나의 그룹으로 묶기 위한 속성이다.

이는 실제 프로그램의 실행에는 전혀 관계 없이 OpenAPI/Swagger UI 문서에 해당 메서드 들을 그룹으로 묶기 위함이다.

 

이렇게 메서드가 선언되어 있을때 문서에는

이런식으로 모든 메서드가 구분없이 단일로 출력되게 되어 있다.

 

여기서 라우팅 데코레이터에 tags로 str로 된 단일 배열로 user에 대한건 "user"로 admin에 대한건 "admin"으로 설정해주면

이렇게 해당 메서드가 어떤 것에 대한것인지 카테고리를 만들어줄 수 있다.

ReDoc에서는 이렇게 분리되어 있게된다.

 

2. Summary 와 Description

Summary 태그부터 시작해보면 

이렇게 문자열을 넣어주면 되고 이렇게 설정하면 

해당 부분에 설명으로 들어가게 된다

ReDoc에서는

이렇게 리스트에 나오는 목록이 변경되게 된다.

 

description을 써보면

이렇게 설정하고 

이렇게 설정된 디테일한 설명이 보인다.

ReDoc에서는 해당 API를 선택하면 상세에서 나오게 된다.

 

 

좀 더 간단하게 description에 내용을 남기려면 

함수 내부에 " 세개를 넣고 그 사이에 내용을 작성해주면 된다 .

이 때는 description이 들어가 있으면 이게 우선순위로 잡혀 아래 내용이 출력되지 않는다.

 

여기서 문자열에 **를 넣어 주고 **로 닫아주면 

굵은 글씨로 표현된다.

 

3. response_description

응답에 대한 상세설명을 작성하는 것으로 

이렇게 작성하면

이렇게 응답에 대한 설명으로 확인할 수 있다.

4. deprecated

문서에 해당 메서드가 곧 사용이 중지될것임을 알려주는 역할을 한다.

해당 속성의 값은 True / False로 설정해주면 된다.

이렇게 deprecated를 확인할 수 있다.