From 251adb5e4fb62340569bda69a77c0e831f362f50 Mon Sep 17 00:00:00 2001 From: Kaur Matthias Raavel Date: Tue, 30 Sep 2025 17:07:32 +0300 Subject: [PATCH] Fixed users endpoint path in swagger --- docs/docs.go | 36 ++++++++++++++++++----------------- docs/swagger.json | 36 ++++++++++++++++++----------------- docs/swagger.yaml | 37 ++++++++++++++++++------------------ internal/controller/users.go | 2 +- 4 files changed, 58 insertions(+), 53 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index 5abdc7d..9e52716 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -102,7 +102,7 @@ const docTemplate = `{ } } }, - "/users/username/{username}": { + "/users/id/{id}": { "get": { "security": [ { @@ -115,12 +115,12 @@ const docTemplate = `{ "tags": [ "users" ], - "summary": "Get user by username", + "summary": "Get user by ID", "parameters": [ { - "type": "string", - "description": "Username", - "name": "username", + "type": "integer", + "description": "User ID", + "name": "id", "in": "path", "required": true } @@ -132,6 +132,12 @@ const docTemplate = `{ "$ref": "#/definitions/model.User" } }, + "400": { + "description": "invalid id", + "schema": { + "$ref": "#/definitions/model.ErrorResponse" + } + }, "404": { "description": "user not found", "schema": { @@ -147,7 +153,7 @@ const docTemplate = `{ } } }, - "/users/{id}": { + "/users/username/{username}": { "get": { "security": [ { @@ -160,12 +166,12 @@ const docTemplate = `{ "tags": [ "users" ], - "summary": "Get user by ID", + "summary": "Get user by username", "parameters": [ { - "type": "integer", - "description": "User ID", - "name": "id", + "type": "string", + "description": "Username", + "name": "username", "in": "path", "required": true } @@ -177,12 +183,6 @@ const docTemplate = `{ "$ref": "#/definitions/model.User" } }, - "400": { - "description": "invalid id", - "schema": { - "$ref": "#/definitions/model.ErrorResponse" - } - }, "404": { "description": "user not found", "schema": { @@ -196,7 +196,9 @@ const docTemplate = `{ } } } - }, + } + }, + "/users/{id}": { "put": { "security": [ { diff --git a/docs/swagger.json b/docs/swagger.json index 470c68f..11d6457 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -95,7 +95,7 @@ } } }, - "/users/username/{username}": { + "/users/id/{id}": { "get": { "security": [ { @@ -108,12 +108,12 @@ "tags": [ "users" ], - "summary": "Get user by username", + "summary": "Get user by ID", "parameters": [ { - "type": "string", - "description": "Username", - "name": "username", + "type": "integer", + "description": "User ID", + "name": "id", "in": "path", "required": true } @@ -125,6 +125,12 @@ "$ref": "#/definitions/model.User" } }, + "400": { + "description": "invalid id", + "schema": { + "$ref": "#/definitions/model.ErrorResponse" + } + }, "404": { "description": "user not found", "schema": { @@ -140,7 +146,7 @@ } } }, - "/users/{id}": { + "/users/username/{username}": { "get": { "security": [ { @@ -153,12 +159,12 @@ "tags": [ "users" ], - "summary": "Get user by ID", + "summary": "Get user by username", "parameters": [ { - "type": "integer", - "description": "User ID", - "name": "id", + "type": "string", + "description": "Username", + "name": "username", "in": "path", "required": true } @@ -170,12 +176,6 @@ "$ref": "#/definitions/model.User" } }, - "400": { - "description": "invalid id", - "schema": { - "$ref": "#/definitions/model.ErrorResponse" - } - }, "404": { "description": "user not found", "schema": { @@ -189,7 +189,9 @@ } } } - }, + } + }, + "/users/{id}": { "put": { "security": [ { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 712819d..7c4bc48 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -107,13 +107,21 @@ paths: summary: Delete user by ID tags: - users - get: + put: + consumes: + - application/json parameters: - description: User ID in: path name: id required: true type: integer + - description: User + in: body + name: user + required: true + schema: + $ref: '#/definitions/model.User' produces: - application/json responses: @@ -122,37 +130,34 @@ paths: schema: $ref: '#/definitions/model.User' "400": - description: invalid id + description: invalid id or body mismatch schema: $ref: '#/definitions/model.ErrorResponse' "404": description: user not found schema: $ref: '#/definitions/model.ErrorResponse' + "409": + description: user with username/email already exists + schema: + $ref: '#/definitions/model.ErrorResponse' "500": description: internal server error schema: $ref: '#/definitions/model.ErrorResponse' security: - ApiKeyAuth: [] - summary: Get user by ID + summary: Update user by ID tags: - users - put: - consumes: - - application/json + /users/id/{id}: + get: parameters: - description: User ID in: path name: id required: true type: integer - - description: User - in: body - name: user - required: true - schema: - $ref: '#/definitions/model.User' produces: - application/json responses: @@ -161,24 +166,20 @@ paths: schema: $ref: '#/definitions/model.User' "400": - description: invalid id or body mismatch + description: invalid id schema: $ref: '#/definitions/model.ErrorResponse' "404": description: user not found schema: $ref: '#/definitions/model.ErrorResponse' - "409": - description: user with username/email already exists - schema: - $ref: '#/definitions/model.ErrorResponse' "500": description: internal server error schema: $ref: '#/definitions/model.ErrorResponse' security: - ApiKeyAuth: [] - summary: Update user by ID + summary: Get user by ID tags: - users /users/username/{username}: diff --git a/internal/controller/users.go b/internal/controller/users.go index 556b821..e39c680 100644 --- a/internal/controller/users.go +++ b/internal/controller/users.go @@ -67,7 +67,7 @@ func (c *UserController) GetUserByUsername(ctx *gin.Context) { // @Failure 404 {object} model.ErrorResponse "user not found" // @Failure 500 {object} model.ErrorResponse "internal server error" // @Security ApiKeyAuth -// @Router /users/{id} [get] +// @Router /users/id/{id} [get] func (c *UserController) GetUserByID(ctx *gin.Context) { idStr := ctx.Param("id") id, err := strconv.ParseInt(idStr, 10, 64)