5. display_name과 description 인자

⑤의 display_name 모델 필드에는 특이 사항이 없습니다. username부터 사용한 description 인자를 살펴보겠습니다. 이 인자는 Pydantic에서 사용하는 것인데, FastAPI는 이 정보를 OpenAPI Specification 3나 ReDoc에서 사용합니다.

▲ 그림 5-3 SQLModel/Pydantic의 모델 필드가 코드 문서화에 표시되는 예시

코드단에서 사람을 위한 설명문 역할을 하면서 동시에 API 문서에서도 설명문으로 사용하는 것이지요.