Swaggerの導入 #9
Comments
1 task
yuminn-k
added a commit
to yuminn-k/project_minori-gin-deployment-repo
that referenced
this issue
Feb 13, 2024
- Change the module name in go.mod from 'minori' to 'github.com/YJU-OKURA/project_minori-gin-deployment-repo'. - This update resolves the issue where Swagger documentation was not accessible due to a module path mismatch. - Ensure consistent and correct import paths across the project. Related issue: YJU-OKURA#9
yuminn-k
added a commit
to yuminn-k/project_minori-gin-deployment-repo
that referenced
this issue
Feb 24, 2024
- Added 'title' and 'version' fields to Swagger JSON and YAML documentation. - Ensured compliance with Swagger documentation standards. - Enhanced clarity and completeness of API documentation. Related issue: YJU-OKURA#9
yuminn-k
added a commit
to yuminn-k/project_minori-gin-deployment-repo
that referenced
this issue
Feb 26, 2024
Updated Swagger documentation to include new routes and models for group board management in the API. This includes the addition of group board create, update, delete, and list endpoints with detailed descriptions and necessary parameters. Related issue: * YJU-OKURA#42 * YJU-OKURA#9
Merged
yuminn-k
added a commit
to yuminn-k/project_minori-gin-deployment-repo
that referenced
this issue
Mar 7, 2024
- Adjusted Swagger tags in 'docs.go' for improved categorization and clarity. - This includes changes in tag naming from lowercase to capitalized versions for consistency. Related issue: YJU-OKURA#9
Merged
yuminn-k
added a commit
to yuminn-k/project_minori-gin-deployment-repo
that referenced
this issue
Apr 5, 2024
Class tagged documents in Swagger Docs were not coming out correctly, so we're updating and committing a new one. Related issue: YJU-OKURA#9
yuminn-k
added a commit
to yuminn-k/project_minori-gin-deployment-repo
that referenced
this issue
May 18, 2024
Modified summary, parameter descriptions, and names in Swagger to align with conventions. Related issue: YJU-OKURA#9
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
📝 Issueの概要
このIssueの目的は、
GinバックエンドフレームワークにSwaggerを導入し、APIドキュメンテーションの自動生成とエンドポイントのテストを容易にすることです。目標は、Swaggerを利用して、開発者がAPIをより効率的に理解し、利用できるようにすることです。📚 背景情報
現在、我々のプロジェクトではAPIのドキュメントが手動で更新されており、しばしば最新の状態になっていません。Swaggerを導入することで、APIの変更がリアルタイムでドキュメントに反映され、エンドポイントのテストが容易になります。これにより、開発プロセスの効率化を図ります。
📋 具体的な作業内容
Ginフレームワークの現行バージョンを確認し、Swaggerとの互換性を評価する。Swagger関連のライブラリとツールを導入する。Swaggerアノテーションを追加し、ドキュメントを生成する。📎 関連するIssueやドキュメント
なし
🖼️ 参考スクリーンショットや図
Swaggerの導入例や、期待されるドキュメントのスクリーンショットをこちらに添付します。
🔄 Issueの進行状況
GinとSwaggerの互換性評価Swagger関連ライブラリの導入Swaggerアノテーションの追加とドキュメント生成The text was updated successfully, but these errors were encountered: