Menu
Add WebSocket, GraphQL, or file-upload endpoints to an EchoNext app. Use when building real-time/WebSocket handlers (Hub pattern), wiring a gqlgen GraphQL schema, or accepting multipart file uploads with validation.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Use the EchoNext CLI to scaffold projects and code, run the dev loop, build, test, and manage the database. Use when creating a new echonext project, generating code (domain/handler/service/model/dto/middleware/openapi/graphql/ websocket/upload), or running dev/build/test/db commands.
Work with EchoNext's database layer: GORM models, the generic Repository[T] pattern from pkg/contrib/database, and Atlas migrations/seeds via the CLI. Use when defining models, querying/persisting data, or creating and applying migrations in an echonext project.
Scaffold and wire up a complete EchoNext domain (model + service + handler + DTO) following the framework's conventional layout. Use when adding a new resource, feature, or entity to an echonext project (e.g. "add a users endpoint", "create a products domain").
Write and register type-safe EchoNext HTTP handlers, request structs, and routes. Use when adding, editing, or debugging an echonext handler function, a request/response struct, validation tags, or a route registration (GET/POST/PUT/PATCH/DELETE).
Configure EchoNext's auto-generated OpenAPI spec and authentication. Use when setting API metadata (title/servers/contact), serving the OpenAPI JSON or Swagger UI, or adding auth (bearer/JWT, API key, OAuth2, OpenID Connect) via security schemes and per-route or global security requirements.
Write tests for EchoNext APIs using the pkg/contrib/testing helpers — APIClient for in-process HTTP requests, Suite for setup/teardown, and FixtureManager for seeding test data. Use when writing or fixing tests for echonext handlers, services, or endpoints.
| name | echonext-integrations |
| description | Add WebSocket, GraphQL, or file-upload endpoints to an EchoNext app. Use when building real-time/WebSocket handlers (Hub pattern), wiring a gqlgen GraphQL schema, or accepting multipart file uploads with validation. |
| license | MIT |
| metadata | {"version":"0.1.0"} |
Beyond standard JSON handlers, EchoNext ships first-class support for three
integration types, each with its own package and route method. Scaffold any of
them with echonext generate websocket|graphql|upload (see echonext-cli),
then fill in the logic using the references below.
app.WS(...)Implement the websocket.Handler interface (connect/message/disconnect
lifecycle) and register it. A Hub tracks connections and broadcasts.
app.WS("/ws/chat", chatHandler, echonext.Route{
Summary: "Chat WebSocket",
Tags: []string{"Chat"},
})
The interface (note OnMessage takes a messageType int):
type Handler interface {
OnConnect(conn *websocket.Connection) error
OnMessage(conn *websocket.Connection, messageType int, data []byte) error
OnDisconnect(conn *websocket.Connection, err error)
}
Full Hub/Connection API and a chat example:
references/websocket.md.
app.GraphQL(...)Pass a gqlgen ExecutableSchema via graphql.Config; the Echo context is
injected so resolvers can read auth/request data.
app.GraphQL(graphql.Config{
Path: "/graphql",
PlaygroundPath: "/playground",
Schema: generated.NewExecutableSchema(generated.Config{Resolvers: r}),
EnableIntrospection: true,
}, graphql.Route{Summary: "GraphQL API", Tags: []string{"GraphQL"}})
Config/Route fields and resolver context access:
references/graphql.md.
app.Upload(...)Use a request struct with *upload.File (or []*upload.File) fields tagged
form:"..."; the framework parses multipart, enforces upload.Config limits,
and validates.
type AvatarRequest struct {
File *upload.File `form:"file" validate:"required"`
}
app.Upload("/avatar", uploadAvatar, echonext.Route{
Summary: "Upload avatar",
Tags: []string{"Avatar"},
FileConfig: &upload.Config{MaxFileSize: 5 << 20, AllowedExtensions: []string{".png", ".jpg"}},
})
File methods (SaveTo, Open, Read, Extension) and multi-file uploads:
references/upload.md.
All three still register routes on the same *App and appear in the generated
OpenAPI spec (upload as multipart; GraphQL/WS documented per their Route).