Может ли Spring Restdocs генерировать живую документацию, как чванство?

Question

Как разработчик, я предпочитаю весенние restdocs. Но, как потребитель документации, я считаю, что живая документация чванства очень привлекательна. Вот вездесущий пример: http://petstore.swagger.io/

Есть ли способ документировать мой apis по отдыху с помощью весенних restdocs, но генерировать с ним живую документацию, такую ​​как swagger petstore? Если так, как ты это делаешь?

Answer 1

Нет, это невозможно из коробки. REST Docs предназначен для расширения, так что вы можете добавить функциональность самостоятельно, но это будет значительным мероприятием.

Я являюсь руководителем проекта REST Docs, и поддержка живой документации представляет интерес, но в данный момент это не особенно приоритетно. По моему опыту, живая документация может быть полезна в качестве игровой площадки, но она плохо справляется с документированием услуги. Сейчас я сосредоточен на создании точной и хорошо структурированной документации. Использование REST Docs со Slate может дать вам толчок к последнему, если вы ищете что-то более направляющее, чем чистый холст Asciidoctor.