Автоматически создавать документацию веб-сервисов ReST / WADL

Question

Мы создаем веб-службы ReST, используя ASP.NET и OpenRasta.

Есть ли какой-нибудь инструмент, который может нам помочь:

• создать файл WADL

• или / и создать удобочитаемый APIаналогичная документация, в которой описаны ресурсы / методы HTTP, поддерживаемые для каждого ресурса, и т. д.

Answer 1

Похоже, REST. Описать и скомпилировать должно помочь.

На сайте разработчиков WADL Марк Хэдли поддерживает инструмент командной строки под названием WADL2Java.Амбициозная цель REST Describe & Compile - предоставить что-то вроде WADL2Anything.Итак, что делает REST Describe & Compile, так это:

• Генерация новых файлов WADL полностью интерактивным способом.
• Позволяет загружать и редактировать существующие файлы WADL.
• Позволяет компилировать файлы WADL в исходный код на разных языках программирования.

Answer 2

Для OpenRasta было бы возможно использовать UriDecorator для определения URI идентичных справке для ваших ресурсов (таких как / myResource $ help).Затем вы можете переписать URI, прежде чем приступить к разбору чего-либо, что вы можете легко документировать, проанализировать, найти тип ресурса и переписать в / help / {resourcetype}

Оттуда вы зарегистрируете ресурс для своей справочной системы:ResourceSpace.Has.ResourcesOfType () .AtUri ("/ help / {resourceType}") .HandledBy () .RenderedByXxx ()

Затем вы можете создать свой обработчик для возврата документации о ресурсе.Например, вы можете использовать службу IOperationCreator, чтобы узнать, какие методы http доступны и с какими входными аргументами, использовать ICodecRepository, чтобы увидеть, какие типы мультимедиа могут быть приняты в качестве входных данных, и, возможно, как будет выглядеть сериализация типов мультимедиа, вызывая кодек исоздание дружественного HTML-представления.

Это определенно область, над которой мы будем работать в следующей версии.