Sobes.tech
Junior — Middle

Jakými prostředky nebo nástroji jste používali pro automatickou generaci dokumentace Swagger?

sobes.tech AI

Odpověď od AI

Pro automatické generování dokumentace Swagger v projektech v jazyce Go se často používá balíček swaggo/swag. Umožňuje generovat specifikaci OpenAPI (Swagger) z komentářů v kódu.

Příklad použití:

  1. Nainstalujte nástroj:
go install github.com/swaggo/swag/cmd/swag@latest
  1. Přidejte komentáře k vašim HTTP handlerům, například:
// @Summary Získat uživatele
// @Description Získat uživatele podle ID
// @Tags users
// @Accept json
// @Produce json
// @Param id path int true "ID uživatele"
// @Success 200 {object} User
// @Router /users/{id} [get]
func GetUser(c *gin.Context) {
    // implementace
}
  1. Vygenerujte dokumentaci příkazem:
swag init
  1. Připojte vygenerované soubory k vašemu HTTP serveru pro zobrazení UI Swagger.

Také jsou populární nástroje go-swagger a echo-swagger pro framework Echo.