nfel/Igris
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add http handlers, docs

Browse Source
This commit is contained in:
AmirMahdi Qiasvand
2025-09-15 16:45:16 +03:30
parent 5829b471d5
commit b2d5659aec
7 changed files with 466 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs.go
+149 -15
View File
@@ -9,16 +9,7 @@ const docTemplate = `{
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "API Support",
"url": "http://www.swagger.io/support",
"email": "support@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
@@ -127,6 +118,110 @@ const docTemplate = `{
}
}
}
},
"/auth/send-otp": {
"post": {
"description": "Send OTP code to the provided phone number",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Send OTP code",
"parameters": [
{
"description": "OTP Request",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.OTPProviderReq"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dto.OTPProviderResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
},
"/auth/verify-otp": {
"post": {
"description": "Verify the provided OTP code for the phone number",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Verify OTP code",
"parameters": [
{
"description": "OTP Verify Request",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.OTPVerifyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dto.OTPVerifyResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
},
"definitions": {
@@ -183,18 +278,57 @@ const docTemplate = `{
"type": "string"
}
}
},
"dto.OTPProviderReq": {
"type": "object",
"properties": {
"receptor": {
"type": "string"
}
}
},
"dto.OTPProviderResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"dto.OTPVerifyRequest": {
"type": "object",
"required": [
"code",
"phone"
],
"properties": {
"code": {
"type": "string"
},
"phone": {
"type": "string"
}
}
},
"dto.OTPVerifyResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "localhost:8080",
BasePath: "/api",
Version: "",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "DeZone API",
Description: "This is the DeZone backend API server.",
Title: "",
Description: "",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
docs/swagger.json
+144 -15
View File
@@ -1,22 +1,8 @@
{
"swagger": "2.0",
"info": {
"description": "This is the DeZone backend API server.",
"title": "DeZone API",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "API Support",
"url": "http://www.swagger.io/support",
"email": "support@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0"
"contact": {}
},
"host": "localhost:8080",
"basePath": "/api",
"paths": {
"/auth/authenticate": {
"post": {
@@ -121,6 +107,110 @@
}
}
}
},
"/auth/send-otp": {
"post": {
"description": "Send OTP code to the provided phone number",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Send OTP code",
"parameters": [
{
"description": "OTP Request",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.OTPProviderReq"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dto.OTPProviderResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
},
"/auth/verify-otp": {
"post": {
"description": "Verify the provided OTP code for the phone number",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Verify OTP code",
"parameters": [
{
"description": "OTP Verify Request",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.OTPVerifyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dto.OTPVerifyResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
},
"definitions": {
@@ -177,6 +267,45 @@
"type": "string"
}
}
},
"dto.OTPProviderReq": {
"type": "object",
"properties": {
"receptor": {
"type": "string"
}
}
},
"dto.OTPProviderResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"dto.OTPVerifyRequest": {
"type": "object",
"required": [
"code",
"phone"
],
"properties": {
"code": {
"type": "string"
},
"phone": {
"type": "string"
}
}
},
"dto.OTPVerifyResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}
docs/swagger.yaml
+94 -13
View File
@@ -1,4 +1,3 @@
basePath: /api
definitions:
dto.AuthenticateRequest:
properties:
@@ -35,19 +34,33 @@ definitions:
timeStamp:
type: string
type: object
host: localhost:8080
dto.OTPProviderReq:
properties:
receptor:
type: string
type: object
dto.OTPProviderResponse:
properties:
message:
type: string
type: object
dto.OTPVerifyRequest:
properties:
code:
type: string
phone:
type: string
required:
- code
- phone
type: object
dto.OTPVerifyResponse:
properties:
message:
type: string
type: object
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: This is the DeZone backend API server.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: DeZone API
version: "1.0"
contact: {}
paths:
/auth/authenticate:
post:
@@ -117,4 +130,72 @@ paths:
summary: Generate authentication challenge
tags:
- auth
/auth/send-otp:
post:
consumes:
- application/json
description: Send OTP code to the provided phone number
parameters:
- description: OTP Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.OTPProviderReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.OTPProviderResponse'
"400":
description: Bad Request
schema:
additionalProperties:
type: string
type: object
"500":
description: Internal Server Error
schema:
additionalProperties:
type: string
type: object
summary: Send OTP code
tags:
- auth
/auth/verify-otp:
post:
consumes:
- application/json
description: Verify the provided OTP code for the phone number
parameters:
- description: OTP Verify Request
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.OTPVerifyRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.OTPVerifyResponse'
"400":
description: Bad Request
schema:
additionalProperties:
type: string
type: object
"401":
description: Unauthorized
schema:
additionalProperties:
type: string
type: object
summary: Verify OTP code
tags:
- auth
swagger: "2.0"