2014-06-04 18 views
5

Nếu tôi có một hàm trả về này:Viết một hàm làm JSON bằng Yard?

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

Tôi ghi lại nó như thế này:

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

tôi tự hỏi nếu có một cách tốt hơn của tài liệu như thế nào JSON trở lại sẽ trông giống như .

+0

Bạn có tìm thấy cách nào tốt hơn không? – josal

Trả lời

0

Vì vậy, nếu bạn quan tâm đến tài liệu về API của bạn, tôi cho rằng bạn cũng quan tâm đến việc kiểm tra để các điểm cuối API của bạn có thể có kiểm tra. Tôi khuyên bạn nên sử dụng Rspec API Documentation. Nếu bạn hiện không sử dụng Rspec tôi sẽ cung cấp cho thử nghiệm Apipie. Cả hai công cụ này sẽ giúp đảm bảo rằng tài liệu API của bạn nhất quán và luôn được cập nhật.

Các vấn đề liên quan