Development
Build with GonexmainBuild APIs with Gonex
Development snapshot · main · No release published yet.
FOR APPLICATION DEVELOPERS

Build APIs with Gonex

Install Gonex, generate projects and modules with its CLI, and develop typed JSON APIs with validation, OpenAPI and structured logs.

Gonex is an API-first Go framework with explicit modules, typed request/response schemas, validation and OpenAPI. Install the dependency, create your own application, add modules and implement APIs inside that application.

Start building

  1. Install Gonex and its CLI.
  2. Create a project, add a module and run it.
  3. Build a REST API with create/list/get endpoints.
  4. Understand the generated structure.
  5. Enable the welcome page and development errors.
  6. Configure server output and logs, then deploy.

A database, gRPC and HTTP versioning are optional. Frontends consume Gonex over HTTP; the built-in welcome and error pages are development diagnostics, while frontends remain separate applications.

Familiar API responsibilities

ResponsibilityGonex file
Request/response schemas and validation, DTOs and validationschemas.go
HTTP handlers, request-to-service mappinghandlers.go
Endpoint registration, typed route declarationsroutes.go
Business behaviorservice.go
Feature compositionmodule.go

The comparison describes responsibilities, not identical APIs. Automatic model-to-CRUD generation and an administration interface are not current features.

Two documentation paths

Build with Gonex is the main track for application developers: package installation, CLI projects, modules, API development, optional persistence and deployment. No framework fork or clone is required.

Contribute to Gonex is for changing the framework itself: source setup, internals, tests and pull requests. Clone instructions stay there.

Version support

The version selector chooses a documentation snapshot. It is separate from optional HTTP API versions such as /api/v1. These guides pin a reviewed main development snapshot; no stable release is assumed. See release status and upgrades.

Edit this guide ↗Source snapshot 3ca54b4