Laravel 웅변 모델 및 Swagger openApi 주석 문제

Question

그래서 내 사용자 모델에는 사용자의 전체 이름을 반환하는 fullname 함수가 있습니다.

으아악

예상대로 작동합니다. 이제 모델에 OpenAPI 주석을 추가하고 싶습니다. 제가 한 일은 다음과 같습니다:

으아악

현재 이 기능은 더 이상 예상대로 작동하지 않습니다.

으아악

더 이상 null 값을 반환하지 않습니다.

문제: 댓글을 유지하면서 기능도 작동하게 만들고 싶습니다.

참고: 웅변적인 예를 통해 사용자에 액세스하는 경우. ( User::all()->first(); ) 이름과 성을 얻었지만 전체 이름은 얻지 못했습니다. 도움을 주셔서 감사합니다

Answer 1

https://github.com/DarkaOnLine/L5-Swagger/issues/157

이 질문에 따르면: 모델의 속성을 정의하면 많은 문제가 발생할 수 있습니다

이 문제를 해결하는 3가지 방법을 찾았습니다:

옵션 1: 최소한의 리팩토링을 수행해야 합니다

댓글을 유지하고 속성 정의를 제거하세요. 예: 이것은:

으아악

다음과 같이 됩니다:

으아악

참고: 속성이나 주석은 변수나 함수 위에 있어야 합니다. 그렇지 않으면 오류가 발생합니다.

옵션 2: 더 깔끔하지만 작업이 더 추가됩니다

공개 API 선언을 다른 곳에 두세요. 예:

• 응답 리소스: https://github.com/DarkaOnLine/ L5-Swagger/issues/157#issuecomment-406204764
• 새 디렉터리(더미)를 만들고 모든 OpenAPI 주석을 여기에 넣습니다. https://github.com/DarkaOnLine/L5-Swagger/issues/157#issuecomment-655865772

옵션 3: 이것이 제가 사용하는 것입니다

스키마 선언에 속성을 추가하세요. 예:

으아악