Update API Documentation and Swagger Configuration for Opplens

- Changed API title and version in Swagger documentation from "Tender Management API" to "Opplens API" with version 1.0.0.
- Updated contact information and terms of service URLs to reflect the new branding for Opplens.
- Added a new "Notification" tag in the Swagger documentation for public notification management operations.
- Adjusted the Swagger endpoint path for documentation to improve routing consistency.
- Enhanced response structure in notification handlers to include metadata, improving clarity in API responses.
This commit is contained in:
n.nakhostin
2025-09-27 10:57:30 +03:30
parent 939f940499
commit 7110e55cf5
6 changed files with 51 additions and 44 deletions
+13 -9
View File
@@ -9,11 +9,11 @@ const docTemplate = `{
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"termsOfService": "https://tender-management.com/terms",
"termsOfService": "https://opplens.com/terms",
"contact": {
"name": "Tender Management API Support",
"url": "https://tender-management.com/support",
"email": "api-support@tender-management.com"
"name": "Opplens API Support",
"url": "https://opplens.com",
"email": "info@opplens.com"
},
"license": {
"name": "MIT",
@@ -8952,18 +8952,22 @@ const docTemplate = `{
{
"description": "Public flag management operations for mobile application including flag retrieval and listing",
"name": "Flags"
},
{
"description": "Public notification management operations for mobile application including notification listing and detailed notification information",
"name": "Notification"
}
]
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "2.0.0",
Host: "localhost:8082",
BasePath: "/",
Version: "1.0.0",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "Tender Management API",
Description: "This is a comprehensive API for the Tender Management System built with Clean Architecture principles and Domain-Driven Design (DDD) patterns. The API provides endpoints for user management, customer management, company management, and authentication for both web panel administration and mobile application access.",
Title: "Opplens API",
Description: "This is a comprehensive API for the Opplens built with Clean Architecture principles and Domain-Driven Design (DDD) patterns. The API provides endpoints for user management, customer management, company management, and authentication for both web panel administration and mobile application access.",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",