Автоматически генерировать API Explorer для служб WCF - PullRequest
6 голосов
/ 08 сентября 2011

Если вы когда-либо использовали Flickr API , вы будете знакомы с их API Explorer. Это потрясающий инструмент, который позволяет вам просматривать документацию по каждому методу API и функцию-убийцу, представляющую собой выполнение этого метода API (с формой для заполнения любых параметров запроса). Он даже обнаруживает, когда вы вошли в систему, и завершает часть аутентификации от вашего имени. Gowalla имеет похожий API Explorer , что тоже очень хорошо.

Существуют ли инструменты для WCF, которые будут автоматически генерировать такой API Explorer, бесплатный или коммерческий?

В настоящее время мы используем Fiddler для создания запросов JSON, но я хотел бы опубликовать эти сервисные контракты и позволить потенциальным разработчикам поиграть с ними через веб-интерфейс API Explorer.

Мне известна страница справки WCF Web HTTP Service , которую я использую (и это здорово), но меня интересует часть API Explorer.

Ответы [ 3 ]

2 голосов
/ 07 февраля 2012

Возможно, вы захотите взглянуть на I / O Docs - систему интерактивной документации с открытым исходным кодом для веб-API RESTful, которую любой владелец API может использовать для развертывания своей собственной документации.Он работает на Node.js и использует Redis в качестве хранилища данных.

https://github.com/mashery/iodocs

Пример: developer.klout.com/iodocs, developer.rottentomatoes.com/iodocs

Он использует файлы на основе схемы JSON для определения конечных точек API, методи параметры.На основе этих файлов JSON создается клиентский интерфейс, который разработчики могут использовать для изучения и изучения вашего API.Вызовы API могут выполняться непосредственно из интерфейса документации, создавая отформатированные ответы.

Это с открытым исходным кодом, так что вы можете быть уверены в регулярных обновлениях и улучшениях.Фактически, в прошедшие выходные Брэндон Уэст из SendGrid (который использует документы ввода-вывода для своей документации) создал и открыл пользовательский интерфейс с открытым исходным кодом для создания / редактирования файлов схемы JSON для документов ввода-вывода.Поэтому вам больше не нужно вручную создавать файлы JSON.

https://github.com/brandonmwest/iodoctor

0 голосов
/ 27 октября 2011

Взгляните на Апигея: http://apigee.com/

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

Не совсем то, что вы искали, но .... WCF предоставляет для этой цели нечто, называемое Тестовый клиент WCF .

Если вы установите Visual Studio, вы получите его.Например, для VS2008, установленного в обычном месте, вы можете найти тестовый клиент WCF (WcfTestClient.exe) в следующем расположении:
C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...