refactor(api): move Swagger UI to docs route

README.md

@@ -29,7 +29,7 @@ Open:
 
 - App: `http://127.0.0.1:3000`
 - Health check: `http://127.0.0.1:8080/health`
-- Swagger UI: `http://127.0.0.1:8080/docs`
+- Swagger UI: `http://127.0.0.1:8080/docs/`
 - OpenAPI document: `http://127.0.0.1:8080/openapi.json`
 
 After backend changes, restart it or run `docker compose up --build` again so the running container uses the latest code.

backend/internal/httpapi/docs.go

@@ -34,8 +34,8 @@ const swaggerUI = `<!doctype html>
 // RegisterDocumentation registers the OpenAPI document and its Swagger UI.
 func RegisterDocumentation(mux *http.ServeMux) {
 	mux.HandleFunc("GET /openapi.json", serveOpenAPI)
-	mux.HandleFunc("GET /swagger/", serveSwaggerUI)
-	mux.HandleFunc("GET /docs", redirectToSwaggerUI)
+	mux.HandleFunc("GET /docs/", serveSwaggerUI)
+	mux.HandleFunc("GET /docs", redirectToDocumentation)
 }
 
 func serveOpenAPI(w http.ResponseWriter, _ *http.Request) {
@@ -48,6 +48,6 @@ func serveSwaggerUI(w http.ResponseWriter, _ *http.Request) {
 	_, _ = w.Write([]byte(swaggerUI))
 }
 
-func redirectToSwaggerUI(w http.ResponseWriter, r *http.Request) {
-	http.Redirect(w, r, "/swagger/", http.StatusTemporaryRedirect)
+func redirectToDocumentation(w http.ResponseWriter, r *http.Request) {
+	http.Redirect(w, r, "/docs/", http.StatusTemporaryRedirect)
 }

backend/internal/httpapi/docs_test.go

@@ -26,16 +26,21 @@ func TestRegisterDocumentation(t *testing.T) {
 		},
 		{
 			name:            "Swagger UI",
-			path:            "/swagger/",
+			path:            "/docs/",
 			wantStatus:      http.StatusOK,
 			wantContentType: "text/html; charset=utf-8",
 			wantBody:        `url: "/openapi.json"`,
 		},
 		{
-			name:         "documentation shortcut",
+			name:         "documentation trailing slash",
 			path:         "/docs",
 			wantStatus:   http.StatusTemporaryRedirect,
-			wantLocation: "/swagger/",
+			wantLocation: "/docs/",
+		},
+		{
+			name:       "removed Swagger route",
+			path:       "/swagger/",
+			wantStatus: http.StatusNotFound,
 		},
 	}