feat: add API versioning , translate swagger, remove rate limiter
This commit is contained in:
Mephimeow
+53
-47
@@ -17,16 +17,17 @@ func NewHandler(service *Service) *Handler {
|
||||
return &Handler{service: service}
|
||||
}
|
||||
|
||||
// @Summary Register
|
||||
// @Description Создание учетной записи пользователя с полями username, email, password
|
||||
// @Summary Регистрация
|
||||
// @Description Создание новой учётной записи. После успешной регистрации сразу возвращается access_token и refresh_token.
|
||||
// @Description Пароль должен содержать минимум 8 символов, заглавную букву, строчную букву и цифру.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param request body RegisterRequest true "Registration details"
|
||||
// @Success 201 {object} AuthResponse
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 409 {object} ErrorResponse
|
||||
// @Router /api/auth/register [post]
|
||||
// @Param request body RegisterRequest true "Данные для регистрации"
|
||||
// @Success 201 {object} AuthResponse "Пользователь создан, токены в ответе"
|
||||
// @Failure 400 {object} ErrorResponse "Ошибка валидации полей (некорректный email, слабый пароль)"
|
||||
// @Failure 409 {object} ErrorResponse "Email уже зарегистрирован"
|
||||
// @Router /api/v1/auth/register [post]
|
||||
func (h *Handler) Register(c *gin.Context) {
|
||||
var req RegisterRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
@@ -52,16 +53,16 @@ func (h *Handler) Register(c *gin.Context) {
|
||||
c.JSON(http.StatusCreated, resp)
|
||||
}
|
||||
|
||||
// @Summary Login
|
||||
// @Description Аунтефикация пользователя с помощью email и password, возвращает JWT token
|
||||
// @Summary Вход
|
||||
// @Description Аутентификация по email и паролю. Возвращает access_token (JWT) и refresh_token.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param request body LoginRequest true "Login credentials"
|
||||
// @Success 200 {object} AuthResponse
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 401 {object} ErrorResponse
|
||||
// @Router /api/auth/login [post]
|
||||
// @Param request body LoginRequest true "Email и пароль"
|
||||
// @Success 200 {object} AuthResponse "Успешный вход, токены в ответе"
|
||||
// @Failure 400 {object} ErrorResponse "Ошибка валидации полей"
|
||||
// @Failure 401 {object} ErrorResponse "Неверный email или пароль"
|
||||
// @Router /api/v1/auth/login [post]
|
||||
func (h *Handler) Login(c *gin.Context) {
|
||||
var req LoginRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
@@ -83,16 +84,17 @@ func (h *Handler) Login(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, resp)
|
||||
}
|
||||
|
||||
// @Summary Refresh token
|
||||
// @Description Получение ново
|
||||
// @Summary Обновление токенов
|
||||
// @Description Получение новой пары токенов по refresh_token. Старый refresh_token становится недействительным (ротация).
|
||||
// @Description Если refresh_token истёк или уже был использован — придёт 401.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param request body RefreshRequest true "Refresh token"
|
||||
// @Success 200 {object} AuthResponse
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 401 {object} ErrorResponse
|
||||
// @Router /api/auth/refresh [post]
|
||||
// @Param request body RefreshRequest true "Действительный refresh_token"
|
||||
// @Success 200 {object} AuthResponse "Новая пара токенов"
|
||||
// @Failure 400 {object} ErrorResponse "Не указан refresh_token"
|
||||
// @Failure 401 {object} ErrorResponse "Refresh_token недействителен или истёк"
|
||||
// @Router /api/v1/auth/refresh [post]
|
||||
func (h *Handler) Refresh(c *gin.Context) {
|
||||
var req RefreshRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
@@ -114,16 +116,16 @@ func (h *Handler) Refresh(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, resp)
|
||||
}
|
||||
|
||||
// @Summary Logout
|
||||
// @Description Аннулирует refresh token
|
||||
// @Summary Выход
|
||||
// @Description Аннулирование refresh_token. После выхода повторное использование того же refresh_token вернёт 401.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param request body LogoutRequest true "Refresh token to invalidate"
|
||||
// @Success 200 {object} map[string]string
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 401 {object} ErrorResponse
|
||||
// @Router /api/auth/logout [post]
|
||||
// @Param request body LogoutRequest true "Refresh_token для аннулирования"
|
||||
// @Success 200 {object} map[string]string "{"message": "logged out successfully"}"
|
||||
// @Failure 400 {object} ErrorResponse "Не указан refresh_token"
|
||||
// @Failure 401 {object} ErrorResponse "Refresh_token не найден или уже аннулирован"
|
||||
// @Router /api/v1/auth/logout [post]
|
||||
func (h *Handler) Logout(c *gin.Context) {
|
||||
var req LogoutRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
@@ -144,15 +146,16 @@ func (h *Handler) Logout(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, gin.H{"message": "logged out successfully"})
|
||||
}
|
||||
|
||||
// @Summary Get current user
|
||||
// @Description Получить профиль авторизованного пользователя
|
||||
// @Summary Профиль пользователя
|
||||
// @Description Получение профиля текущего авторизованного пользователя.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Success 200 {object} UserResponse
|
||||
// @Failure 401 {object} ErrorResponse
|
||||
// @Router /api/auth/me [get]
|
||||
// @Success 200 {object} UserResponse "Данные пользователя"
|
||||
// @Failure 401 {object} ErrorResponse "Токен не указан или недействителен"
|
||||
// @Router /api/v1/auth/me [get]
|
||||
func (h *Handler) Me(c *gin.Context) {
|
||||
userID := api.GetUserID(c)
|
||||
if userID == "" {
|
||||
@@ -174,17 +177,19 @@ func (h *Handler) Me(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, UserResponse{User: *user})
|
||||
}
|
||||
|
||||
// @Summary Change password
|
||||
// @Description Изменить текущий password пользователя
|
||||
// @Summary Смена пароля
|
||||
// @Description Изменение пароля текущего пользователя. Требуется указать старый и новый пароль.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Description Пароль должен содержать минимум 8 символов, заглавную букву, строчную букву и цифру.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param request body PasswordChangeRequest true "Password change details"
|
||||
// @Success 200 {object} map[string]string
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 401 {object} ErrorResponse
|
||||
// @Router /api/auth/password [put]
|
||||
// @Param request body PasswordChangeRequest true "Старый и новый пароль"
|
||||
// @Success 200 {object} map[string]string "{"message": "password changed successfully"}"
|
||||
// @Failure 400 {object} ErrorResponse "Ошибка валидации: неверный старый пароль, слабый новый или совпадают"
|
||||
// @Failure 401 {object} ErrorResponse "Токен не указан или недействителен"
|
||||
// @Router /api/v1/auth/password [put]
|
||||
func (h *Handler) ChangePassword(c *gin.Context) {
|
||||
userID := api.GetUserID(c)
|
||||
if userID == "" {
|
||||
@@ -216,17 +221,18 @@ func (h *Handler) ChangePassword(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, gin.H{"message": "password changed successfully"})
|
||||
}
|
||||
|
||||
// @Summary Update profile
|
||||
// @Description Обновить username текущего пользователя
|
||||
// @Summary Обновление профиля
|
||||
// @Description Обновление username текущего пользователя.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags auth
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param request body UpdateProfileRequest true "Profile update"
|
||||
// @Success 200 {object} UserResponse
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 401 {object} ErrorResponse
|
||||
// @Router /api/auth/me [put]
|
||||
// @Param request body UpdateProfileRequest true "Новый username"
|
||||
// @Success 200 {object} UserResponse "Обновлённый профиль"
|
||||
// @Failure 400 {object} ErrorResponse "Ошибка валидации: username от 3 до 30 символов"
|
||||
// @Failure 401 {object} ErrorResponse "Токен не указан или недействителен"
|
||||
// @Router /api/v1/auth/me [put]
|
||||
func (h *Handler) UpdateProfile(c *gin.Context) {
|
||||
userID := api.GetUserID(c)
|
||||
if userID == "" {
|
||||
|
||||
@@ -1,87 +0,0 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
type visitor struct {
|
||||
count int
|
||||
lastSeen time.Time
|
||||
}
|
||||
|
||||
type RateLimiter struct {
|
||||
mu sync.Mutex
|
||||
visitors map[string]*visitor
|
||||
rate int
|
||||
window time.Duration
|
||||
done chan struct{}
|
||||
}
|
||||
|
||||
func NewRateLimiter(rate int, window time.Duration) *RateLimiter {
|
||||
rl := &RateLimiter{
|
||||
visitors: make(map[string]*visitor),
|
||||
rate: rate,
|
||||
window: window,
|
||||
done: make(chan struct{}),
|
||||
}
|
||||
go rl.cleanup()
|
||||
return rl
|
||||
}
|
||||
|
||||
func (rl *RateLimiter) Stop() {
|
||||
close(rl.done)
|
||||
}
|
||||
|
||||
func (rl *RateLimiter) cleanup() {
|
||||
ticker := time.NewTicker(10 * time.Minute)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-rl.done:
|
||||
return
|
||||
case <-ticker.C:
|
||||
rl.mu.Lock()
|
||||
now := time.Now()
|
||||
for ip, v := range rl.visitors {
|
||||
if now.Sub(v.lastSeen) > rl.window*2 {
|
||||
delete(rl.visitors, ip)
|
||||
}
|
||||
}
|
||||
rl.mu.Unlock()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (rl *RateLimiter) Middleware() gin.HandlerFunc {
|
||||
return func(c *gin.Context) {
|
||||
ip := c.ClientIP()
|
||||
|
||||
rl.mu.Lock()
|
||||
v, exists := rl.visitors[ip]
|
||||
now := time.Now()
|
||||
|
||||
if !exists || now.Sub(v.lastSeen) > rl.window {
|
||||
rl.visitors[ip] = &visitor{count: 1, lastSeen: now}
|
||||
rl.mu.Unlock()
|
||||
c.Next()
|
||||
return
|
||||
}
|
||||
|
||||
v.count++
|
||||
v.lastSeen = now
|
||||
|
||||
if v.count > rl.rate {
|
||||
rl.mu.Unlock()
|
||||
c.JSON(http.StatusTooManyRequests, gin.H{"error": "too many requests, try again later"})
|
||||
c.Abort()
|
||||
return
|
||||
}
|
||||
|
||||
rl.mu.Unlock()
|
||||
c.Next()
|
||||
}
|
||||
}
|
||||
+39
-34
@@ -17,17 +17,18 @@ func NewHandler(service *Service) *Handler {
|
||||
return &Handler{service: service}
|
||||
}
|
||||
|
||||
// @Summary Create organization
|
||||
// @Description Create a new organization
|
||||
// @Summary Создание организации
|
||||
// @Description Создание новой организации. slug используется в URL и должен быть уникальным.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags organizations
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param request body CreateOrgRequest true "Organization details"
|
||||
// @Success 201 {object} OrgResponse
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 409 {object} ErrorResponse
|
||||
// @Router /api/organizations [post]
|
||||
// @Param request body CreateOrgRequest true "Название и slug организации"
|
||||
// @Success 201 {object} OrgResponse "Организация создана"
|
||||
// @Failure 400 {object} ErrorResponse "Ошибка валидации полей"
|
||||
// @Failure 409 {object} ErrorResponse "Slug уже занят"
|
||||
// @Router /api/v1/organizations [post]
|
||||
func (h *Handler) Create(c *gin.Context) {
|
||||
var req CreateOrgRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
@@ -49,16 +50,17 @@ func (h *Handler) Create(c *gin.Context) {
|
||||
c.JSON(http.StatusCreated, OrgResponse{Organization: *org})
|
||||
}
|
||||
|
||||
// @Summary Get organization by ID
|
||||
// @Description Get organization details
|
||||
// @Summary Получить организацию
|
||||
// @Description Получение информации об организации по её ID.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags organizations
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param id path string true "Organization ID"
|
||||
// @Success 200 {object} OrgResponse
|
||||
// @Failure 404 {object} ErrorResponse
|
||||
// @Router /api/organizations/{id} [get]
|
||||
// @Param id path string true "UUID организации"
|
||||
// @Success 200 {object} OrgResponse "Данные организации"
|
||||
// @Failure 404 {object} ErrorResponse "Организация не найдена"
|
||||
// @Router /api/v1/organizations/{id} [get]
|
||||
func (h *Handler) GetByID(c *gin.Context) {
|
||||
id := c.Param("id")
|
||||
|
||||
@@ -76,17 +78,18 @@ func (h *Handler) GetByID(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, OrgResponse{Organization: *org})
|
||||
}
|
||||
|
||||
// @Summary List organizations
|
||||
// @Description Get all organizations with pagination
|
||||
// @Summary Список организаций
|
||||
// @Description Получение списка всех организаций с пагинацией.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags organizations
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param limit query int false "Page size (default 20)"
|
||||
// @Param offset query int false "Offset (default 0)"
|
||||
// @Success 200 {object} OrgListResponse
|
||||
// @Failure 500 {object} ErrorResponse
|
||||
// @Router /api/organizations [get]
|
||||
// @Param limit query int false "Количество записей на странице (по умолчанию 20)"
|
||||
// @Param offset query int false "Смещение от начала списка (по умолчанию 0)"
|
||||
// @Success 200 {object} OrgListResponse "Список организаций"
|
||||
// @Failure 500 {object} ErrorResponse "Внутренняя ошибка сервера"
|
||||
// @Router /api/v1/organizations [get]
|
||||
func (h *Handler) List(c *gin.Context) {
|
||||
limit, _ := strconv.Atoi(c.DefaultQuery("limit", "20"))
|
||||
offset, _ := strconv.Atoi(c.DefaultQuery("offset", "0"))
|
||||
@@ -101,18 +104,19 @@ func (h *Handler) List(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, resp)
|
||||
}
|
||||
|
||||
// @Summary Update organization
|
||||
// @Description Update organization name
|
||||
// @Summary Обновление организации
|
||||
// @Description Обновление названия организации. slug изменить нельзя.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags organizations
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param id path string true "Organization ID"
|
||||
// @Param request body UpdateOrgRequest true "New organization details"
|
||||
// @Success 200 {object} OrgResponse
|
||||
// @Failure 400 {object} ErrorResponse
|
||||
// @Failure 404 {object} ErrorResponse
|
||||
// @Router /api/organizations/{id} [put]
|
||||
// @Param id path string true "UUID организации"
|
||||
// @Param request body UpdateOrgRequest true "Новое название организации"
|
||||
// @Success 200 {object} OrgResponse "Обновлённая организация"
|
||||
// @Failure 400 {object} ErrorResponse "Ошибка валидации полей"
|
||||
// @Failure 404 {object} ErrorResponse "Организация не найдена"
|
||||
// @Router /api/v1/organizations/{id} [put]
|
||||
func (h *Handler) Update(c *gin.Context) {
|
||||
id := c.Param("id")
|
||||
|
||||
@@ -136,16 +140,17 @@ func (h *Handler) Update(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, OrgResponse{Organization: *org})
|
||||
}
|
||||
|
||||
// @Summary Delete organization
|
||||
// @Description Delete an organization
|
||||
// @Summary Удаление организации
|
||||
// @Description Безвозвратное удаление организации по её ID.
|
||||
// @Description **Требуется:** заголовок `Authorization: Bearer <token>`.
|
||||
// @Tags organizations
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security Bearer
|
||||
// @Param id path string true "Organization ID"
|
||||
// @Success 200 {object} map[string]string
|
||||
// @Failure 404 {object} ErrorResponse
|
||||
// @Router /api/organizations/{id} [delete]
|
||||
// @Param id path string true "UUID организации"
|
||||
// @Success 200 {object} map[string]string "{"message": "organization deleted"}"
|
||||
// @Failure 404 {object} ErrorResponse "Организация не найдена"
|
||||
// @Router /api/v1/organizations/{id} [delete]
|
||||
func (h *Handler) Delete(c *gin.Context) {
|
||||
id := c.Param("id")
|
||||
|
||||
|
||||
Reference in New Issue
Block a user