README
¶
go-openapi-validator Examples
This directory contains several examples demonstrating how to integrate go-openapi-validator with different Go web routers and frameworks. These examples cover various use cases, from basic manual route registration to advanced automated handler mapping.
Documentation Index
| Example | Router / Framework | Description |
|---|---|---|
| Gin (Regular) | Gin-gonic | Manual route registration with OpenAPI validation middleware. |
| Gin (Handler Mapping) | Gin-gonic | Automated route registration using operationId and custom extensions. |
| Gorilla Mux | Gorilla Mux | Standard integration with the popular Gorilla Mux router. |
| Standard Library | net/http |
Integration with the standard library http.ServeMux. |
Key Features Demonstrated
- Request Validation: Ensuring incoming requests match the OpenAPI specification.
- Response Validation: Validating outgoing responses against the spec (useful for development).
- Swagger UI Integration: Serving a built-in Swagger UI with live spec validation.
- Automated Routing: Reducing boilerplate by mapping OpenAPI
operationIdto Go handlers.
Getting Started
To run any of the examples, navigate to the respective directory and use the standard go run command:
cd examples/gin
go run main.go
Once the server is running, you can access the Swagger UI at http://localhost:8081/docs.
Directories
Click to show internal directories.
Click to hide internal directories.