2014-02-17 3 views
0

В большой системе, где есть множество ресурсов, я хочу, чтобы разделенная документация была сконфигурирована.ASP.NET Web Api 2 Разделение документации?

Как будто они были разными.

Итак, на главной странице веб-api у меня есть список настроенных «ресурсов».

Скажем: Управление контактов [Здесь я хочу выставить «контакт» ресурс, «Адрес» ресурс и т.д. управления заказами [ресурсы продукта, заказ ресурсов, поставка ресурсов, баланс ресурсов, и т.д.] Управления продукты [ресурс продукта, ресурс категории и т. д.]

Таким образом, потребителям api проще понять, на основе задачи, чтобы решить, какие методы следует позаботиться.

Кроме того, как вы можете видеть, различные секции используют одни и те же ресурсы, что означает, что если я что-то изменить на ресурс продукта, оба Документации должны (в идеале) будет автоматически обновляться, в том числе контроля версий информации и т.д.

EDIT :

public ActionResult Index() 
    { 
     ViewBag.DocumentationProvider = Configuration.Services.GetDocumentationProvider(); 
     return View(Configuration.Services.GetApiExplorer().ApiDescriptions); 
    } 

это мой указательный действие на helpcontroller, не уверен, что вы имеете в виду.

ответ

1

Вы посмотрели HelpController под Areas\HelpPage\Controllers? Если вы заметили, что действие Index этого контроллера отображает информацию обо всех контроллерах. Если каждый ваш ресурс представлен контроллером, вы должны иметь возможность фильтровать ApiDescription, чтобы показывать только те ресурсы, которые вам нравятся.

+0

не уверен, что вы имеете в виду, я отредактировал вопрос с моим действием индекса. –

+0

Как вы можете заметить, это действие индекса возвращает все 'ApiDescription' всех контроллеров или ресурсов в вашем случае. Вы можете отфильтровать эти описания, чтобы отображать только контроллеры, которые вы хотели бы показать. –

 Смежные вопросы

  • Нет связанных вопросов^_^