Mathis/lemma
1
0
Fork 0
mirror of https://github.com/lordmathis/lemma.git synced 2025-11-05 23:44:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Working swagger api docs

Browse Source
This commit is contained in:
Matúš Námešný
2024-12-03 22:06:57 +01:00
parent e413e955c5
commit dc8fc6c225
8 changed files with 4863 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
server/internal/app/routes.go
View File

@@ -11,6 +11,10 @@ import (
"github.com/go-chi/cors"
"github.com/go-chi/httprate"
"github.com/unrolled/secure"
httpSwagger "github.com/swaggo/http-swagger"
_ "novamd/docs" // Swagger docs
)
// setupRouter creates and configures the chi router with middleware and routes
@@ -49,6 +53,12 @@ func setupRouter(o Options) *chi.Mux {
Storage: o.Storage,
}
if o.Config.IsDevelopment {
r.Get("/swagger/*", httpSwagger.Handler(
httpSwagger.URL("/swagger/doc.json"), // The URL pointing to API definition
))
}
// API routes
r.Route("/api/v1", func(r chi.Router) {
// Rate limiting for API routes

9
server/internal/handlers/file_handlers.go
View File

@@ -108,12 +108,12 @@ func (h *Handler) LookupFileByName() http.HandlerFunc {
// @Produce plain
// @Param workspace_name path string true "Workspace name"
// @Param file_path path string true "File path"
// @Success 200 {string} "File content"
// @Success 200 {string} string "Raw file content"
// @Failure 400 {object} ErrorResponse "Invalid file path"
// @Failure 404 {object} ErrorResponse "File not found"
// @Failure 500 {object} ErrorResponse "Failed to read file"
// @Failure 500 {object} ErrorResponse "Failed to write response"
// @Router /workspaces/{workspace_name}/files/* [get]
// @Router /workspaces/{workspace_name}/files/{file_path} [get]
func (h *Handler) GetFileContent() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
ctx, ok := context.GetRequestContext(w, r)
@@ -162,7 +162,7 @@ func (h *Handler) GetFileContent() http.HandlerFunc {
// @Failure 400 {object} ErrorResponse "Failed to read request body"
// @Failure 400 {object} ErrorResponse "Invalid file path"
// @Failure 500 {object} ErrorResponse "Failed to save file"
// @Router /workspaces/{workspace_name}/files/* [post]
// @Router /workspaces/{workspace_name}/files/{file_path} [post]
func (h *Handler) SaveFile() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
ctx, ok := context.GetRequestContext(w, r)
@@ -205,7 +205,6 @@ func (h *Handler) SaveFile() http.HandlerFunc {
// @Tags files
// @ID deleteFile
// @Security BearerAuth
// @Produce string
// @Param workspace_name path string true "Workspace name"
// @Param file_path path string true "File path"
// @Success 204 "No Content - File deleted successfully"
@@ -213,7 +212,7 @@ func (h *Handler) SaveFile() http.HandlerFunc {
// @Failure 404 {object} ErrorResponse "File not found"
// @Failure 500 {object} ErrorResponse "Failed to delete file"
// @Failure 500 {object} ErrorResponse "Failed to write response"
// @Router /workspaces/{workspace_name}/files/* [delete]
// @Router /workspaces/{workspace_name}/files/{file_path} [delete]
func (h *Handler) DeleteFile() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
ctx, ok := context.GetRequestContext(w, r)

6
server/internal/handlers/workspace_handlers.go
View File

@@ -14,8 +14,8 @@ type DeleteWorkspaceResponse struct {
NextWorkspaceName string `json:"nextWorkspaceName"`
}
// GetLastWorkspaceNameResponse contains the name of the last opened workspace
type GetLastWorkspaceNameResponse struct {
// LastWorkspaceNameResponse contains the name of the last opened workspace
type LastWorkspaceNameResponse struct {
LastWorkspaceName string `json:"lastWorkspaceName"`
}
@@ -325,7 +325,7 @@ func (h *Handler) GetLastWorkspaceName() http.HandlerFunc {
return
}
respondJSON(w, &GetLastWorkspaceNameResponse{LastWorkspaceName: workspaceName})
respondJSON(w, &LastWorkspaceNameResponse{LastWorkspaceName: workspaceName})
}
}