Generate the OpenAPI spec with Huma instead of swag
The spec is now built from the same calls that register the routes, so it
can't drift from the router like the swag comments did (all /api/v1
routes were missing).
- /api/v1 endpoints are typed Huma operations; the spec is OpenAPI 3.1 at
/openapi.json (3.0 at /openapi-3.0.json, YAML too), docs at /docs.
/openapi and /swagger/* redirect there
- Bearer token security is declared per operation; token creation and
the new GET /api/v1/health are public
- Legacy routes use the same handlers, are hidden from the spec and keep
the Deprecation header
- /sync/reset is hidden (debug only); the /sync/new, /sync/quick and
/sync/new/full aliases are removed (use /sync and /sync/full)
- Invalid parameters return 422 (validation); every error is
{"error": "..."}; empty lists are [] instead of null
- /sync/progress is documented as progress or result (oneOf)
- Tests validate the spec and check real responses of every documented
operation against it (kin-openapi)
- Removed swag annotations, cmd/docs, echo-swagger and the swag tool
This commit is contained in:
1 parent
0ec2425f78
commit
973ebf224b
37 files changed
+1245
-5967
No files matched your search
@@ -1,16 +1,10 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"github.com/labstack/echo/v5"
|
||||
)
|
||||
import "github.com/danielgtaylor/huma/v2"
|
||||
|
||||
// DeprecationMiddleware adds deprecation warning to responses
|
||||
// for old endpoints that are being phased out in favor of /api/v1/*
|
||||
func DeprecationMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
|
||||
return func(c *echo.Context) error {
|
||||
// Add deprecation warning header
|
||||
c.Response().Header().Add("Warning", `299 - "Deprecated: This endpoint is deprecated. Use /api/v1/ endpoints instead."`)
|
||||
c.Response().Header().Add("Deprecation", "true")
|
||||
return next(c)
|
||||
}
|
||||
// Deprecation marks responses from legacy routes as deprecated in favour of /api/v1.
|
||||
func Deprecation(ctx huma.Context, next func(huma.Context)) {
|
||||
ctx.AppendHeader("Warning", `299 - "Deprecated: This endpoint is deprecated. Use /api/v1/ endpoints instead."`)
|
||||
ctx.AppendHeader("Deprecation", "true")
|
||||
next(ctx)
|
||||
}
|
||||
Reference in new issue
Block a user