Sobes.tech
Back to questions
Junior — Middle
86

Какими средствами или инструментами вы использовали для автоматической генерации документации Swagger?

Companies where asked
Холодильник.руХолодильник.ру

Answer from AI

sobes.tech AI

Для автоматической генерации документации Swagger в проектах на Go часто используют пакет swaggo/swag. Он позволяет генерировать спецификацию OpenAPI (Swagger) из комментариев в коде.

Пример использования:

  1. Устанавливаете инструмент:
go install github.com/swaggo/swag/cmd/swag@latest
  1. Добавляете комментарии к вашим обработчикам HTTP, например:
// @Summary Получить пользователя
// @Description Получить пользователя по ID
// @Tags users
// @Accept json
// @Produce json
// @Param id path int true "User ID"
// @Success 200 {object} User
// @Router /users/{id} [get]
func GetUser(c *gin.Context) {
    // реализация
}
  1. Генерируете документацию командой:
swag init
  1. Подключаете сгенерированные файлы к вашему HTTP-серверу для отображения UI Swagger.

Также популярны инструменты go-swagger и echo-swagger для фреймворка Echo.