feat: update docs models responses
This commit is contained in:
@@ -4,6 +4,7 @@ import (
|
||||
"strconv"
|
||||
|
||||
"gitea.d3m0k1d.ru/d3m0k1d/d3m0k1d.ru/backend/internal/logger"
|
||||
"gitea.d3m0k1d.ru/d3m0k1d/d3m0k1d.ru/backend/internal/models"
|
||||
"gitea.d3m0k1d.ru/d3m0k1d/d3m0k1d.ru/backend/internal/repositories"
|
||||
"gitea.d3m0k1d.ru/d3m0k1d/d3m0k1d.ru/backend/internal/storage"
|
||||
"github.com/gin-gonic/gin"
|
||||
@@ -25,19 +26,22 @@ func NewPostHandlers(repo repositories.PostRepository) *PostHandlers {
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Success 200 {object} []storage.PostReq
|
||||
// @Failure 404 {object} models.ErrorResponse "No Post found"
|
||||
// @Failure 500 {object} models.ErrorResponse "Internal server error"
|
||||
// @Failure 400 {object} models.ErrorResponse "Invalid ID format"
|
||||
// @Router /posts [get]
|
||||
func (h *PostHandlers) GetPosts(c *gin.Context) {
|
||||
var result []storage.PostReq
|
||||
result, err := h.repo.GetAll(c.Request.Context())
|
||||
if err != nil {
|
||||
h.logger.Error("error request: " + err.Error())
|
||||
c.Status(500)
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
}
|
||||
if result == nil {
|
||||
c.JSON(200, gin.H{"Status": "No Post found"})
|
||||
models.Error(c, 404, "No Post found", "")
|
||||
}
|
||||
h.logger.Info("200 OK GET /posts")
|
||||
c.JSON(200, result)
|
||||
models.Success(c, result)
|
||||
}
|
||||
|
||||
// GetPost godoc
|
||||
@@ -47,35 +51,35 @@ func (h *PostHandlers) GetPosts(c *gin.Context) {
|
||||
// @Accept json
|
||||
// @Param id path int true "Post ID"
|
||||
// @Produce json
|
||||
// @Success 200 {object} storage.PostReq
|
||||
// @Failure 400 {object} map[string]string "Invalid ID format"
|
||||
// @Failure 404 {object} map[string]string "Post not found"
|
||||
// @Failure 500 {object} map[string]string "Internal server error"
|
||||
// @Success 200 {object} models.SuccessResponse{data=storage.PostReq}
|
||||
// @Failure 400 {object} models.ErrorResponse "Invalid ID format"
|
||||
// @Failure 404 {object} models.ErrorResponse "Post not found"
|
||||
// @Failure 500 {object} models.ErrorResponse "Internal server error"
|
||||
// @Router /posts/{id} [get]
|
||||
func (h *PostHandlers) GetPost(c *gin.Context) {
|
||||
var result storage.PostReq
|
||||
last_id, err := h.repo.GetLastID(c.Request.Context())
|
||||
if err != nil {
|
||||
h.logger.Error("error request: " + err.Error())
|
||||
c.Status(500)
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
}
|
||||
id_p := c.Param("id")
|
||||
id, err := strconv.Atoi(id_p)
|
||||
if err != nil {
|
||||
h.logger.Error("error request: " + err.Error())
|
||||
c.JSON(400, gin.H{"error": "Invalid ID format"})
|
||||
models.Error(c, 400, "Invalid ID format", err.Error())
|
||||
}
|
||||
if id > last_id {
|
||||
c.JSON(404, gin.H{"error": "Post not found"})
|
||||
models.Error(c, 404, "Post not found", "")
|
||||
return
|
||||
}
|
||||
result, err = h.repo.GetByID(c.Request.Context(), id)
|
||||
if err != nil {
|
||||
h.logger.Error("error request: " + err.Error())
|
||||
c.Status(500)
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
}
|
||||
h.logger.Info("200 OK GET /posts/" + id_p)
|
||||
c.JSON(200, result)
|
||||
models.Success(c, result)
|
||||
|
||||
}
|
||||
|
||||
@@ -86,14 +90,14 @@ func (h *PostHandlers) GetPost(c *gin.Context) {
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param post body storage.PostCreate true "Post data"
|
||||
// @Success 200 {object} storage.PostReq
|
||||
// @Failure 400 {object} gin.H
|
||||
// @Success 200 {object} models.SuccessResponse{data=storage.Post}
|
||||
// @Failure 400 {object} models.ErrorResponse "Invalid request"
|
||||
// @Router /posts [post]
|
||||
func (h *PostHandlers) CreatePost(c *gin.Context) {
|
||||
var req storage.PostCreate
|
||||
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
c.JSON(400, gin.H{"error": err.Error()})
|
||||
models.Error(c, 400, "Invalid request", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
@@ -103,11 +107,11 @@ func (h *PostHandlers) CreatePost(c *gin.Context) {
|
||||
}
|
||||
|
||||
if err := h.repo.Create(c.Request.Context(), post); err != nil {
|
||||
c.JSON(500, gin.H{"error": err.Error()})
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(200, post)
|
||||
models.Success(c, post)
|
||||
}
|
||||
|
||||
// UpdatePost godoc
|
||||
@@ -118,27 +122,30 @@ func (h *PostHandlers) CreatePost(c *gin.Context) {
|
||||
// @Param id path int true "Post ID"
|
||||
// @Param post body storage.PostCreate true "Post data"
|
||||
// @Produce json
|
||||
// @Success 200 {object} storage.PostCreate
|
||||
// @Success 200 {object} models.SuccessResponse{data=storage.PostCreate}
|
||||
// @Failure 400 {object} models.ErrorResponse "Invalid ID format"
|
||||
// @Failure 500 {object} models.ErrorResponse "Internal server error"
|
||||
// Failure 404 {object} models.ErrorResponse "Post not found"
|
||||
// @Router /posts/{id} [put]
|
||||
func (h *PostHandlers) UpdatePost(c *gin.Context) {
|
||||
id_p := c.Param("id")
|
||||
id, err := strconv.Atoi(id_p)
|
||||
if err != nil {
|
||||
h.logger.Error("error request: " + err.Error())
|
||||
c.Status(500)
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
}
|
||||
var req storage.Post
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
c.JSON(400, gin.H{"error": err.Error()})
|
||||
models.Error(c, 400, "Invalid request", err.Error())
|
||||
return
|
||||
}
|
||||
err = h.repo.Update(c.Request.Context(), id, req)
|
||||
if err != nil {
|
||||
c.JSON(500, gin.H{"error": err.Error()})
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(200, req)
|
||||
models.Success(c, req)
|
||||
h.logger.Info("200 OK PUT /posts/" + id_p)
|
||||
}
|
||||
|
||||
@@ -149,26 +156,29 @@ func (h *PostHandlers) UpdatePost(c *gin.Context) {
|
||||
// @Param id path int true "Post ID"
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Success 200 {object} storage.Post
|
||||
// @Failure 404 {object} models.ErrorResponse "Post not found"
|
||||
// @Failure 400 {object} models.ErrorResponse "Invalid ID format"
|
||||
// @Failure 500 {object} models.ErrorResponse "Internal server error"
|
||||
// @Success 200 {object} models.SuccessResponse{data=storage.Post}
|
||||
// @Router /posts/{id} [delete]
|
||||
func (h *PostHandlers) DeletePost(c *gin.Context) {
|
||||
id_p := c.Param("id")
|
||||
id, err := strconv.Atoi(id_p)
|
||||
if err != nil {
|
||||
h.logger.Error("error request: " + err.Error())
|
||||
c.JSON(400, gin.H{"error": "Invalid ID format"})
|
||||
models.Error(c, 400, "Invalid ID format", err.Error())
|
||||
}
|
||||
exsist := h.repo.IsExist(c.Request.Context(), id)
|
||||
if !exsist {
|
||||
c.JSON(404, gin.H{"error": "Post not found"})
|
||||
models.Error(c, 404, "Post not found", "")
|
||||
return
|
||||
}
|
||||
err = h.repo.Delete(c.Request.Context(), id)
|
||||
if err != nil {
|
||||
c.JSON(500, gin.H{"error": err.Error()})
|
||||
models.Error(c, 500, "Internal server error", err.Error())
|
||||
return
|
||||
}
|
||||
h.logger.Info("200 OK DELETE /posts/" + id_p)
|
||||
c.JSON(200, gin.H{"Status": "Post deleted"})
|
||||
models.Success(c, "Post deleted")
|
||||
|
||||
}
|
||||
|
||||
27
backend/internal/models/responses.go
Normal file
27
backend/internal/models/responses.go
Normal file
@@ -0,0 +1,27 @@
|
||||
package models
|
||||
|
||||
import (
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
type SuccessResponse struct {
|
||||
Data interface{} `json:"data"`
|
||||
}
|
||||
|
||||
type ErrorResponse struct {
|
||||
Error ErrorDetail `json:"error"`
|
||||
}
|
||||
|
||||
type ErrorDetail struct {
|
||||
Code int `json:"code"`
|
||||
Message string `json:"message"`
|
||||
Detail string `json:"detail"`
|
||||
}
|
||||
|
||||
func Success(c *gin.Context, data interface{}) {
|
||||
c.JSON(200, SuccessResponse{Data: data})
|
||||
}
|
||||
|
||||
func Error(c *gin.Context, code int, message string, detail string) {
|
||||
c.JSON(code, ErrorResponse{Error: ErrorDetail{Code: code, Message: message, Detail: detail}})
|
||||
}
|
||||
Reference in New Issue
Block a user