mazyar/tm_back
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Company Profile Retrieval Endpoint and Update API Documentation

Browse Source 
- Introduced a new public API endpoint to retrieve the profile of the authenticated user's company, enhancing the functionality of the tender management system.
- Implemented the `MyCompany` method in the company handler to handle requests for the company profile, ensuring proper authentication and error handling.
- Updated Swagger and YAML documentation to accurately reflect the new endpoint, including detailed descriptions, parameters, and response formats for the `CompanyProfileResponse`.
- Modified the router to include the new company profile route, ensuring adherence to Clean Architecture principles and maintaining a clear separation of concerns in the handler layer.
- Enhanced the public routes registration to include the company handler, improving the overall API structure and usability.
This commit is contained in:
n.nakhostin
2025-08-20 12:14:14 +03:30
parent e292839732
commit 843ae22515
7 changed files with 267 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+78
View File
@@ -5069,6 +5069,58 @@ const docTemplate = `{
}
}
},
"/api/v1/companies": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Retrieve the profile of the company associated with the authenticated user",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Company"
],
"summary": "Get my company profile",
"responses": {
"200": {
"description": "Company retrieved successfully",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/company.CompanyProfileResponse"
}
}
}
]
}
},
"401": {
"description": "Unauthorized - User not authenticated",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
}
}
}
},
"/api/v1/feedback": {
"get": {
"security": [
@@ -6513,6 +6565,32 @@ const docTemplate = `{
}
}
},
"company.CompanyProfileResponse": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"created_at": {
"type": "integer"
},
"founded_year": {
"type": "integer"
},
"id": {
"type": "string"
},
"industry": {
"type": "string"
},
"name": {
"type": "string"
},
"registration_number": {
"type": "string"
}
}
},
"company.CompanyResponse": {
"type": "object",
"properties": {
cmd/web/docs/swagger.json
+78
View File
@@ -5063,6 +5063,58 @@
}
}
},
"/api/v1/companies": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Retrieve the profile of the company associated with the authenticated user",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Company"
],
"summary": "Get my company profile",
"responses": {
"200": {
"description": "Company retrieved successfully",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/company.CompanyProfileResponse"
}
}
}
]
}
},
"401": {
"description": "Unauthorized - User not authenticated",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
}
}
}
},
"/api/v1/feedback": {
"get": {
"security": [
@@ -6507,6 +6559,32 @@
}
}
},
"company.CompanyProfileResponse": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"created_at": {
"type": "integer"
},
"founded_year": {
"type": "integer"
},
"id": {
"type": "string"
},
"industry": {
"type": "string"
},
"name": {
"type": "string"
},
"registration_number": {
"type": "string"
}
}
},
"company.CompanyResponse": {
"type": "object",
"properties": {
cmd/web/docs/swagger.yaml
+48
View File
@@ -78,6 +78,23 @@ definitions:
total_pages:
type: integer
type: object
company.CompanyProfileResponse:
properties:
country:
type: string
created_at:
type: integer
founded_year:
type: integer
id:
type: string
industry:
type: string
name:
type: string
registration_number:
type: string
type: object
company.CompanyResponse:
properties:
address:
@@ -4501,6 +4518,37 @@ paths:
summary: Get users by role
tags:
- Admin-Users
/api/v1/companies:
get:
consumes:
- application/json
description: Retrieve the profile of the company associated with the authenticated
user
produces:
- application/json
responses:
"200":
description: Company retrieved successfully
schema:
allOf:
- $ref: '#/definitions/response.APIResponse'
- properties:
data:
$ref: '#/definitions/company.CompanyProfileResponse'
type: object
"401":
description: Unauthorized - User not authenticated
schema:
$ref: '#/definitions/response.APIResponse'
"500":
description: Internal server error
schema:
$ref: '#/definitions/response.APIResponse'
security:
- BearerAuth: []
summary: Get my company profile
tags:
- Company
/api/v1/feedback:
get:
consumes:
cmd/web/main.go
+4 -1
View File
@@ -47,6 +47,9 @@ package main
// @tag.name Authorization
// @tag.description Customer authentication and authorization operations for mobile application including login, logout, token refresh, and profile access
// @tag.name Company
// @tag.description Company information access for mobile application including company profile and company tenders
// @tag.name Tenders
// @tag.description Public tender information access for mobile application including active tender listings and detailed tender information
@@ -146,7 +149,7 @@ func main() {
// Register routes
router.RegisterAdminRoutes(e, userHandler, companyHandler, customerHandler, tenderHandler, feedbackHandler, tenderApprovalHandler)
router.RegisterPublicRoutes(e, customerHandler, tenderHandler, feedbackHandler, tenderApprovalHandler)
router.RegisterPublicRoutes(e, customerHandler, tenderHandler, feedbackHandler, tenderApprovalHandler, companyHandler)
// Start server
serverAddr := fmt.Sprintf("%s:%d", conf.Server.Host, conf.Server.Port)
cmd/web/router/routes.go
+8 -1
View File
@@ -121,7 +121,7 @@ func RegisterAdminRoutes(e *echo.Echo, userHandler *user.Handler, companyHandler
}
}
func RegisterPublicRoutes(e *echo.Echo, customerHandler *customer.Handler, tenderHandler *tender.TenderHandler, feedbackHandler *feedback.Handler, tenderApprovalHandler *tender_approval.Handler) {
func RegisterPublicRoutes(e *echo.Echo, customerHandler *customer.Handler, tenderHandler *tender.TenderHandler, feedbackHandler *feedback.Handler, tenderApprovalHandler *tender_approval.Handler, companyHandler *company.Handler) {
v1 := e.Group("/api/v1")
customerGP := v1.Group("/profile")
@@ -164,4 +164,11 @@ func RegisterPublicRoutes(e *echo.Echo, customerHandler *customer.Handler, tende
tenderApprovalGP.GET("/tender/:tender_id", tenderApprovalHandler.GetTenderApprovalByTenderAndCompany)
tenderApprovalGP.GET("/stats", tenderApprovalHandler.GetCompanyTenderApprovalStats)
}
// Public Company Routes
companiesGP := v1.Group("/companies")
{
companiesGP.Use(customerHandler.AuthMiddleware())
companiesGP.GET("", companyHandler.MyCompany)
}
}