Skip to content

Feature/openapi3 documentation - #907

Closed
muskke wants to merge 6 commits into
QuantumNous:mainfrom
muskke:feature/openapi3-documentation
Closed

Feature/openapi3 documentation#907
muskke wants to merge 6 commits into
QuantumNous:mainfrom
muskke:feature/openapi3-documentation

Conversation

@muskke

@muskke muskke commented Mar 27, 2025

Copy link
Copy Markdown

OpenAPI 3.0文档集成

变更内容

  • 添加了符合OpenAPI 3.0规范的API文档
  • 为主要API端点添加了详细的文档注释
  • 集成了Swagger UI用于可视化浏览API
  • 添加了自动生成文档的工具和构建命令
  • 创建了统一的API响应结构体

如何使用

  1. 运行 make generate-swagger 生成文档
  2. 运行 make swagger-docs 生成文档并启动服务
  3. 访问 http://localhost:3000/swagger/index.html 查看API文档

测试过的环境

  • Go 1.23.4
  • Gin 1.10.0

@muskke muskke closed this Mar 27, 2025
@muskke
muskke deleted the feature/openapi3-documentation branch March 27, 2025 15:28
@muskke
muskke restored the feature/openapi3-documentation branch March 27, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant