좋은 예제/템플릿/모범 사례 API 설명서

웹 서비스의 프런트 엔드와 백엔드를 만드는 임입니다. 나는 서로를 혼란스럽게하지 않으면 서 함께 협력하고 편집 할 수있는 API 호출 문서를 만드는 쉽고 이해하기 쉬운 좋은 방법이 필요합니다.좋은 예제/템플릿/모범 사례 API 설명서

거기에 프로젝트 API 문서의 좋은 스펙/예제 등이 있습니까? 이렇게하면 많은 재 작성으로 엄청난 혼란을 겪을 수 있습니까?

2011-09-07 longstaff

전체 Python 라이브러리는 프로젝트 API 문서의 좋은 예입니다. 여기에서 시작하는 것 같습니다. http://docs.python.org/library/. 이미 가지고있는 것을 사용하는 것이 무엇이 문제입니까? –

완벽을 기하기 위해 백엔드가 파이썬으로 작성된다고 가정합니다. 사용하는 태그는 이것을 나타내지 만 명시 적으로 말하지는 않습니다. –

@MortenSiebuhr 예, 이것은 사실입니다. 그러나 Python을 언어로 알지 못해도 API가 어떻게 작동해야하는지에 대한 지식이 필요하기 때문에 중요하지 않다고 생각하지 않았습니다. – longstaff

문서에 대한 나의 선택 : Sphinx.

기타 :

그러나 스핑크스는 아주 굉장합니다.

2011-09-07 12:34:03 Tauquir

는 파이썬에 아무런 영향을 미치지 않으며 내 자신 만의 변화와 제안을 할 필요가 있기 때문에 너무 좋아 보인다. – longstaff

@shortstick; 파이썬 코딩을 할 필요가 없습니다. 그냥 스핑크스를 설치하면 마크 업을 작성하면됩니다. 파이썬은 전혀 없습니다. – Tauquir

스핑크스는 꽤 잘 작동하는 것 같습니다. 감사! – longstaff

작은 API의 경우 Google 문서 도구를 사용하기 시작했습니다. 협업 기능은 훌륭하며이 문서에서 변경된 모든 사항을 볼 수 있습니다.

2011-09-07 12:36:32

답변