package
0.0.0-20240611080815-1788e2da06bb
Repository: https://github.com/xandermoroz/goblog.git
Documentation: pkg.go.dev

# Functions

@Summary add article to category @Description Adding Article to Category in DB with given request body @Tags Categories @Accept json @Produce json @Param request body models.AddArticleToCategoryBody true "Введите ID статьи и название категории" @Success 201 {string} string @Failure 400 {string} string "Bad Request" @Router /categories/add_article [post].
@Summary create new comment to article @Description Creating new Comment to Article in DB with given request body @Tags Articles @Accept json @Produce json @Param id path string true "Article ID" @Param request body models.CreateCommentRequest true "Введите текст комментария" @Success 201 {string} string @Failure 400 {string} string "Bad Request" @Router /article/{id}/add_comment [post].
@Summary create new article @Description Creating Article in DB with given request body @Tags Articles @Accept json @Produce json @Param request body models.CreateArticleRequest true "Введите данные статьи" @Success 201 {string} string @Failure 400 {string} string "Bad Request" @Router /articles [post].
@Summary create new category @Description Creating Category in DB with given request body @Tags Categories @Accept json @Produce json @Param request body models.CreateCategoryBody true "Введите название категории статьи" @Success 201 {string} string @Failure 400 {string} string "Bad Request" @Router /categories [post].
@Summary delete article from category @Description Deleting Article from Category in DB with given request body @Tags Categories @Accept json @Produce json @Param request body models.AddArticleToCategoryBody true "Введите ID статьи и название категории" @Success 201 {string} string @Failure 400 {string} string "Bad Request" @Router /categories/remove_article [post].
@Summary delete a article by ID @Description Delete a article by ID @ID delete-article-by-id @Tags Articles @Produce json @Param id path string true "articleID" @Success 200 {object} []string @Failure 404 {object} []string @Router /articles/{id} [delete].
@Summary get all articles @Description Get all articles from db @Tags Articles @ID get-all-articles @Produce json @Success 200 {object} []models.ArticleResponse @Router /articles [get].
@Summary get all categories @Description Get all categories from db @Tags Categories @ID get-all-categories @Produce json @Success 200 {object} []models.CategoryResponse @Router /categories [get].
@Summary get an article by ID @Description Get an article by ID @Tags Articles @ID get-article-by-id @Produce json @Param id path string true "Article ID" @Success 200 {object} models.ArticleResponse @Failure 404 {object} []string @Router /articles/{id} [get].
@Summary get current user @Description Get token from users cookee @Tags Authentication @ID get-current-user @Produce json @Success 200 {object} []models.UserResponse @Router /api/v1/current_user [get].
@Summary user authentication @Description Authenticate User in app with given request body @Tags Authentication @Accept json @Produce json @Param request body models.LoginRequest true "Введите данные для авторизации" @Success 201 {string} map[] @Failure 400 {string} string "Bad Request" @Router /api/v1/login [post].
@Summary logout current user @Description Clear JWT token by setting an empty value and expired time in the cookie @Tags Authentication @ID logout-current-user @Produce json @Success 200 {string} map[] @Router /api/v1/logout [get].
@Summary user registration @Description Register User in app with given request body @Tags Authentication @Accept json @Produce json @Param request body models.SignUpUserRequest true "Введите данные для регистрации" @Success 201 {string} map[string]string @Failure 400 {string} string "Bad Request" @Router /api/v1/register [post].
@Summary update article by ID @Description Update article by ID @ID delete-article-by-id @Tags Articles @Produce json @Param id path int true "articleID" @Param request body models.UpdateArticleBody true "Введите новые данные статьи" @Success 200 {object} []string @Failure 404 {object} []string @Router /articles/{id} [put].