Arhn - архитектура программирования

Что делает атрибут [ApiExplorerSettings(IgnoreApi = true)]?

EDIT: я знаю, что вообще делают атрибуты, вопрос касается только этого конкретного атрибута. Извините за путаницу!

Я прочитал следующий вопрос вместе с этим, которые указывают на то, как атрибут используется для игнорирования сгенерированной документации swagger/swashbuckle для определенных методов или целых контроллеров. (документация - это страница чванства со всеми перечисленными API, я полагаю?)

Но кроме swagger/swashbuckle (который является пакетом NuGet), какой еще функцией обладает этот атрибут в ASP.NET?

c# asp.net swagger
19.08.2019

  • Неясно, то ли вы вообще не знаете, что такое атрибуты, то ли вы понимаете атрибуты, но не понимаете, что делает этот конкретный. Два возможных ответа сильно различаются (хотя любой вопрос, вероятно, будет отклонен из-за отсутствия доказательств исследований, а первый, вероятно, тоже будет закрыт как слишком широкий) 19.08.2019
  • Атрибут — это всего лишь маркер, он не обладает функциями и не запускает поведение сам по себе. Итак, возможно, другие библиотеки могли бы использовать этот атрибут; скорее всего, он читается путем отражения, но это ваш выбор чтения или добавления пакетов NuGet, которые его используют. Помимо Swagger, для простого приложения ASP.NET среди основных пакетов Microsoft/ASP.NET я не думаю, что он имеет какое-то особое применение. (И, кстати, насколько я знаю, Swagger не входит в базовые пакеты MS) 20.08.2019
  • Спасибо @Pac0! Это было моей первоначальной заботой. Я знал, что у него есть некоторые функции для swagger/swashbuckle, который является пакетом-самородком, но мне было интересно, есть ли у него какие-то функции для ASP.NET, на что вы ответили! 20.08.2019
  • Я думаю, что это полезный вопрос. Я тоже собираюсь добавить это в свой API, и я тоже боялся, что это может иметь некоторые непредвиденные последствия. Так что это было полезно для меня. 01.12.2020

Ответы:


1

Прежде всего, чтобы уточнить, атрибут в C# сам по себе ничего не запускает. Внешний код ищет классы, методы или свойства, отмеченные определенным атрибутом, и действует соответствующим образом.

Конечно, в ASP.NET MVC много строительных блоков, иногда это может сбивать с толку.

Как вы заметили, этот атрибут используется Swagger и (по крайней мере, в ядре .NET) данными реализациями IApiDescriptionProvider и другие связанные интерфейсы, но это будет эффективно только в том случае, если вы их действительно используете (настроив их в Startup. с)

(для получения дополнительной информации и примера см. https://andrewlock.net/introduction-to-the-apiexplorer-in-asp-net-core/)

21.08.2019

2

При применении к общедоступному методу на контроллере он предотвращает появление этого метода в пользовательском интерфейсе swagger.

22.04.2020
Новые материалы
Коллекции публикаций по глубокому обучению
Последние пару месяцев я создавал коллекции последних академических публикаций по различным подполям глубокого обучения в моем блоге https://amundtveit.com - эта публикация дает обзор 25..
Представляем: Pepita
Фреймворк JavaScript с открытым исходным кодом Я знаю, что недостатка в фреймворках JavaScript нет. Но я просто не мог остановиться. Я хотел написать что-то сам, со своими собственными..
Советы по коду Laravel #2
1-) Найти // You can specify the columns you need // in when you use the find method on a model User::find(‘id’, [‘email’,’name’]); // You can increment or decrement // a field in..
Работа с временными рядами спутниковых изображений, часть 3 (аналитика данных)
Анализ временных рядов спутниковых изображений для данных наблюдений за большой Землей (arXiv) Автор: Рольф Симоэс , Жильберто Камара , Жильберто Кейрос , Фелипе Соуза , Педро Р. Андраде ,..
3 способа решить квадратное уравнение (3-й мой любимый) -
1. Методом факторизации — 2. Используя квадратичную формулу — 3. Заполнив квадрат — Давайте поймем это, решив это простое уравнение: Мы пытаемся сделать LHS,..
Создание VR-миров с A-Frame
Виртуальная реальность (и дополненная реальность) стали главными модными терминами в образовательных технологиях. С недорогими VR-гарнитурами, такими как Google Cardboard , и использованием..
Демистификация рекурсии
КОДЕКС Демистификация рекурсии Упрощенная концепция ошеломляющей О чем весь этот шум? Рекурсия, кажется, единственная тема, от которой у каждого начинающего студента-информатика..