2014-07-14 2 views
0

많은 테스트 사례로 작업하고 있으며 문서화의 효율적인 방법이 무엇인지 궁금합니다. 지금은 스프레드 시트를 사용해 막대한 양을 기록하고 있으므로 더 좋은 방법이 있는지 궁금합니다.RSpec 테스트를 문서화하는 효율적인 방법은 무엇입니까?

자동으로 API에 대한 문서를 생성 할 수있는 Apipie 또는 zipmark 같은 뭔가를 찾고

+0

은 무엇 당신은 당신의 문서가 노출 하시겠습니까? – Matt

+0

zipmark "자동으로 RSpec에서 API 문서를 생성합니다". 그것이 당신이 찾고있는 것 같아서, 당신이 무엇을 요구하고 있는지 불분명합니다. – Powers

+0

실제로 사용하지는 않았지만 zipmark는 RSpec 테스트를 사용하여 API를 문서화하는 대신 자체 테스트의 상위 수준 문서를 작성하는 것 같습니다. –

답변

1

밖으로 https://github.com/square/fdoc

레일 또는시나 응용 프로그램에서 확인, FDOC 문서에게 API를 도울뿐만 아니라 수 있습니다 요청 및 응답이 해당 스키마를 준수하는지 확인하십시오.

FDOC는 또한 샘플 응답에 따라 요청의 스키마 을 추론하는 시도한다 비계 모드가 있습니다 :

은 API 문서를 생성 할 수 있습니다.

https://github.com/square/fdoc/blob/master/docs/scaffold.md

관련 문제