Swagger UI вложенные расширяемые группы

Question

Я использую SwaggerUI для документирования конечных точек API. В настоящее время они сгруппированы по имени контроллера в одном длинном списке. Затем вы можете развернуть каждый контроллер, чтобы просмотреть операции. Все стандартно.

Что я хотел бы сделать, это группа контроллеров под общими расширяемыми группами.

Так, например, у вас есть группа Pet, которую можно развернуть, чтобы выявить контроллеры Cat и Dog, которые затем могут быть расширены, чтобы показать их соответствующие операции.

Я попытался использовать теги, чтобы добиться этого, но лучшее, что я могу получить, - это все операции, сгруппированные под одной расширяемой группой.

Кто-нибудь знает, возможно ли это с помощью стандартного swaggerUI? Или мне нужно создать пользовательский HTML для этого?

Answer 1

Предполагаете, вы используете Swashbuckle? Вам нужно реализовать IDocumentFilter. Посмотрите на теги om Swagger 2.0 Spec.

From the docs:

DocumentFilter

после изменения всего документа Swagger по разводке один или несколько фильтров документов.

IDocumentFilter имеет следующий интерфейс:

void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer); 

Это дает полный контроль, чтобы изменить окончательный SwaggerDocument. Вы можете получить дополнительный контекст из предоставленного SwaggerDocument (например, версии) и IApiExplorer. Вы должны хорошо понимать спецификацию Swagger 2.0. перед использованием этой опции.