마당에서 JSON을 렌더링하는 함수를 문서화 하시겠습니까?

Question

나는이 반환하는 함수가있는 경우 :이처럼 문서화하고

render :json => @orders.as_json(include: [{:user => {only: :id}}], :only => [:id, :status_id]) 

을 :

# @return [JSON] includes the id, the order status id and the id of the associated user 

반환 된 JSON 모양을 어떻게 문서의 더 나은 방법이 있는지 궁금 오전 .

Answer 1

API에 대한 문서가 마음에 들면 API 끝점에 테스트가 포함되어 있으므로 테스트하는 것이 좋습니다. Rspec API Documentation을 사용하는 것이 좋습니다. 현재 Rspec을 사용하고 있지 않다면 Apipie을 시도해보십시오. 이 두 도구는 API 설명서가 일관되고 최신 상태를 유지하도록 보장합니다.