4

Я добавил компонент страниц справки для своего ASP.NET MVC Web API с OData. Чтобы заставить его работать, я должен был явно указать [ApiExplorerSetting (IgnoreAPI = false)].Страницы справки WebAPI не отображают всех конечных точек для контроллера OData

Однако, он показывает только конечную точку GET по умолчанию, например: api/Customers.

Но мой API также поддерживает GET по ID и некоторые свойства навигации, как: API/клиентов (ID) и API/клиентов (ID)/ContactPerson

Есть ли способ сделать Help Pages автогенерацию те конечные точки?

Спасибо!

ответ

4

HelpPage действительно не поддерживается для контроллеров на базе OData, и именно по этой причине мы явно устанавливаем атрибут [ApiExplorerSetting(IgnoreAPI = true)] на ODataController. Даже если вы попытались сделать этот параметр false, не может быть гарантировано, что все вещи (отображающие все маршруты, сгенерированные сэмплы) будут работать так, как ожидалось, поэтому я предлагаю не следовать этому подходу.

+0

Благодарим за ответ –

+4

Не могли бы вы рассказать мне, какой лучший подход при получении документации для OData? Любая ссылка будет оценена по достоинству. – codebased

+0

Во-вторых, что. Я хотел бы иметь возможность генерировать документацию для моих конечных точек OData. – Tim