Существует множество хороших инструментов для получения исходного кода и документации API ( doxygen , Headerdoc , Sphinx и многие другие). Однако ни один из них не особенно хорош при создании документации для API, предоставляемой через интерфейс RPC (если у вас есть рекомендации по синтезу документации по API RPC с помощью этих инструментов, обязательно предложите это).
Меня особенно интересуют инструменты документирования, которые хоть как-то поддерживают JSON и AMQP , но вопрос также будет касаться таких вещей, как Protobuf , Thrift , а XML-RPC и любые предложения инструментов, которые работают с этими технологиями, по крайней мере, дали бы мне место для начала.
Честно говоря, я еще не видел документацию по качеству для любого интерфейса RPC (созданного вручную или с помощью инструмента), и я просто надеюсь, что это потому, что разработчики ленивы, а не потому, что инструменты не существуют.