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

Метод 1: использование JavaScript/jQuery:

Один из способов свернуть все конечные точки Swagger — использовать JavaScript или jQuery. Используя возможности манипулирования DOM, мы можем программно сворачивать или расширять разделы. Вот пример фрагмента кода:

// Collapse all endpoints
$('.opblock').each(function() {
  $(this).removeClass('is-open');
  $(this).find('.opblock-summary').addClass('collapsed');
  $(this).find('.opblock-body').slideUp();
});

Метод 2. Пользовательский стиль CSS:

Другой подход — изменить стили CSS пользовательского интерфейса Swagger, чтобы по умолчанию свернуть все конечные точки. Этот метод подходит, если вы хотите сохранить свернутое состояние в разных сеансах. Вот пример фрагмента кода CSS:

/* Collapse all endpoints */
.opblock.is-open {
  display: none !important;
}
.opblock-summary.collapsed {
  display: block !important;
}
.opblock-body {
  display: none !important;
}

Метод 3. Настройка пользовательского интерфейса Swagger:

Пользовательский интерфейс Swagger предоставляет объект конфигурации, в котором мы можем указать различные параметры, включая свертывание конечных точек. Установив для свойства defaultModelsExpandDepthзначение 0, мы можем свернуть все модели ответов. Вот пример фрагмента конфигурации:

const ui = SwaggerUIBundle({
  // Other configurations...
  defaultModelsExpandDepth: 0,
});

Метод 4. Настройка исходного кода пользовательского интерфейса Swagger:

Для более расширенной настройки вы можете изменить сам исходный код пользовательского интерфейса Swagger. Настраивая соответствующие компоненты, отвечающие за рендеринг конечных точек, вы можете добиться желаемого поведения свертывания. Этот метод требует более глубоких знаний внутреннего устройства пользовательского интерфейса Swagger.

Организация и управление крупными проектами документации API может оказаться непростой задачей. Свернув все конечные точки Swagger, вы можете улучшить взаимодействие с пользователем и упростить разработчикам навигацию по документации. В этой статье мы рассмотрели несколько методов достижения этой цели, включая манипуляции с JavaScript/jQuery, стили CSS, настройку пользовательского интерфейса Swagger и настройку исходного кода пользовательского интерфейса Swagger. Выберите метод, который лучше всего соответствует вашим потребностям, и оптимизируйте документацию API уже сегодня!

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