Rails routes.rb 파일을 사용하여 API 참조 문서를 생성하는 가장 좋은 방법은 무엇입니까?

내 Rails 응용 프로그램 용 API를 문서화하려고하는데 route.rb 파일을 기반으로 XML 파일을 생성하는 더 좋은 방법이 있는지 궁금합니다. 나는 rake routes의 출력과 비슷하지만보다 친숙한 XML 형식 형식을 구상합니다. Corey는 경로 파일에 반사/내성 검사를 사용하는 것에 대한 흥미로운 아이디어가 있지만 here하지만 필요한 것은 아닙니다.Rails routes.rb 파일을 사용하여 API 참조 문서를 생성하는 가장 좋은 방법은 무엇입니까?

제발 이것이 해결 된 문제라고 말하면 제 생각 엔이 문제를 처음으로 생각하지 않습니다.

https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake

이 아마도 당신이 그것에서 관련 일을 배우고 (-cough-) 더 쉬운 XML 형식으로 경로를 생성하는 새 작업을 작성할 수 있습니다 :

출처

2011-01-03 Richard Hurt

API 참조에 대한 추가 요구 사항이나 계획이있는 경우 질문을 구체화 할 수 있습니까? – Heikki

rake routes 정상적인 레이크 작업입니다. ;)

출처

2011-01-03 20:44:50 Heikki

당신이 찾고있는 것에 정확히 일치하는 것을 찾을 수 없었습니다. (놀랍지 만) a sitemap gem을 보면서 원하는 것을 시작할 수 있습니다. 이것은 맞춤 코드 여야 할 수도 있습니다 ... 슬프게도

출처

2011-01-03 20:52:39 brycemcd

'rake routes'는 28 줄의 코드로 생각하면 엄청난 일이 아닐 수도 있습니다. – Heikki

그는 API를 문서화하기 위해 XML 파일을 생성하려고합니다. 요구 사항 중 일부는 레이크 전체가 경로 파일이 API의 일부가 아니라는 것입니다. 또한 레이크 파일은 STOUT으로 파이프되며 그는 XML 파일을 원합니다. Sitemap 생성기가 시작하기에 좋은 장소라고 생각했습니다. – brycemcd

것을 만족시키는 복잡한 사양의 좋은 예입니다. 'rake routes'의 코드는 모든 경로를 출력하지 않습니다. 빌더로 XML을 생성하고 파일에 쓰는 것은 결코 쉬운 일이 아닙니다. – Heikki

Rails routes.rb 파일을 사용하여 API 참조 문서를 생성하는 가장 좋은 방법은 무엇입니까?

답변

관련 문제