Хорошие примеры / шаблоны / лучшая практика API документация - PullRequest
2 голосов
/ 07 сентября 2011

Я создаю внешний интерфейс для веб-службы, а другой - серверный. Мне нужен хороший, простой и понятный способ создания документа вызовов API, с которым мы можем сотрудничать и редактировать вместе, не путая друг друга.

есть ли какие-нибудь хорошие спецификации / примеры и т.д. документации по API проекта, так что это не приведет к огромному беспорядку со многими переписываниями?

Ответы [ 2 ]

2 голосов
/ 07 сентября 2011

Мой выбор для документации: Сфинкс .

Другие:

Но Сфинкс довольно крутой.

0 голосов
/ 07 сентября 2011

Для небольших API я начал использовать Google Docs.Его возможности для совместной работы великолепны, и вы можете увидеть список всех изменений, внесенных в этот документ.

...