2012-01-15 42 views
5

Có cách nào dễ dàng để tạo tài liệu cho REST api trực tiếp từ dự án Symfony không?Tự động tạo tài liệu REST API từ Symfony

+0

Bạn đang sử dụng phiên bản symfony nào? – MrGlass

+0

Chúng tôi đang sử dụng symfony 2 –

+0

Tôi không nghĩ rằng có một cách để làm điều đó tự động. Hầu hết các công cụ cần được xác định trong định tuyến, nhưng điều đó sẽ không hoạt động tốt cho Tài liệu. – MrGlass

Trả lời

9

Xin lỗi vì đã đăng bài, nhưng có một gói Symfony để giúp tạo tài liệu API, bạn có thể xem NelmioApiDocBundle kết nối tốt với FOSRestBundle.

Tài liệu FOSRestBundle cung cấp các gói mẫu sử dụng cả hai nhóm để tạo các dịch vụ web REST-ful và tài liệu của chúng.

+0

là có cách để ghi lại các loại tham số trong Nelmio (tức là dữ liệu mẫu vs json thô ...)? xem [ở đây] (https://github.com/nelmio/NelmioApiDocBundle/issues/403) – abbood

+0

Tôi muốn nói rằng bạn phải sử dụng mô tả cho trường hợp sử dụng cụ thể này. Bạn có thể định dạng nó trong markdown. –

+0

Có cách nào để tạo chú thích không? – dustfeather