| +Server + | +
+generate flag to enable code generation
+ |
++Example usage + | +
|---|---|---|
| + +[Chi](https://github.com/go-chi/chi) + + | +
+chi-server
+ |
+
+
+
+
+
```go
-type FindPetsParams struct {
- Tags *[]string `json:"tags,omitempty"`
- Limit int32 `json:"limit"`
+type PetStoreImpl struct {}
+func (*PetStoreImpl) GetPets(w http.ResponseWriter, r *http.Request) {
+ // Implement me
+}
+
+func SetupHandler() {
+ var myApi PetStoreImpl
+
+ r := chi.NewRouter()
+ r.Mount("/", Handler(&myApi))
}
```
-### Registering handlers
+ |
+
-
+[Echo](https://github.com/labstack/echo)
-Code generated using `-generate server`.
+ |
+
+echo-server
+ |
+
+
-The usage of `Echo` is out of scope of this doc, but once you have an
-echo instance, we generate a utility function to help you associate your handlers
-with this autogenerated code. For the pet store, it looks like this:
+The usage of `Echo` is out of scope of this doc, but once you have an echo instance, we generate a utility function to help you associate your handlers with this autogenerated code. For the pet store, it looks like this:
```go
func RegisterHandlers(router codegen.EchoRouter, si ServerInterface) {
@@ -212,27 +201,31 @@ func SetupHandler() {
```
|
+
| -Code generated using `-generate chi-server`. +[Fiber](https://github.com/gofiber/fiber) -```go -type PetStoreImpl struct {} -func (*PetStoreImpl) GetPets(w http.ResponseWriter, r *http.Request) { - // Implement me -} + | +
+fiber-server
+ |
+|
| - +[Gin](https://github.com/gin-gonic/gin) + | +
+gin-server
+ |
+
Code generated using `-generate gin`.
@@ -255,211 +248,1157 @@ func RegisterHandlersWithOptions(router *gin.Engine, si ServerInterface, options
router.GET(options.BaseURL+"/pets/:id", wrapper.FindPetByID)
return router
}
-```
+```
+
+```go
+import (
+ "github.com/gin-gonic/gin"
+ "github.com/deepmap/oapi-codegen/examples/petstore-expanded/gin/api"
+ middleware "github.com/oapi-codegen/gin-middleware"
+)
+
+type PetStoreImpl struct {}
+func (*PetStoreImpl) GetPets(w http.ResponseWriter, r *http.Request) {
+ // Implement me
+}
+
+func SetupHandler() {
+ var myApi PetStoreImpl
+
+ r := gin.Default()
+ r.Use(middleware.OapiRequestValidator(swagger))
+ r = api.RegisterHandlers(r, petStore)
+}
+```
+
+ |
+
| + +[gorilla/mux](https://github.com/gorilla/mux) + + | +
+gorilla-server
+ |
+|
| + +[Iris](https://github.com/kataras/iris) + + | +
+iris-server
+ |
+
+
+
+
+
+Code generated using `-generate iris`.
+
+The usage of `iris` is out of scope of this doc, but once you have an
+iris instance, we generate a utility function to help you associate your handlers
+with this autogenerated code. For the pet store, it looks like this:
+
+```go
+// RegisterHandlersWithOptions creates http.Handler with additional options
+func RegisterHandlersWithOptions(router *iris.Application, si ServerInterface, options IrisServerOptions) {
+
+ wrapper := ServerInterfaceWrapper{
+ Handler: si,
+ }
+
+ router.Get(options.BaseURL+"/pets", wrapper.FindPets)
+ router.Post(options.BaseURL+"/pets", wrapper.AddPet)
+ router.Delete(options.BaseURL+"/pets/:id", wrapper.DeletePet)
+ router.Get(options.BaseURL+"/pets/:id", wrapper.FindPetByID)
+
+ router.Build()
+}
+```
+
+```go
+import (
+ "github.com/kataras/iris/v12"
+ "github.com/deepmap/oapi-codegen/examples/petstore-expanded/iris/api"
+ middleware "github.com/oapi-codegen/iris-middleware"
+)
+```
+
+The wrapper functions referenced above contain generated code which pulls
+parameters off the `Iris` request context, and unmarshals them into Go objects.
+
+You would register the generated handlers as follows:
+
+```go
+func SetupHandler() {
+ var myApi PetStoreImpl
+
+ i := iris.Default()
+ i.Use(middleware.OapiRequestValidator(swagger))
+ api.RegisterHandlers(r, &myApi)
+}
+```
+
+ |
+
| + +[1.22+ `net/http`](https://pkg.go.dev/net/http) + + | +
+std-http-server
+ |
+
+
+
+
+
+The following servers implement handlers that are directly compatible with the standard library:
+
+- gorilla/mux
+- Chi
+
+Therefore, these can be used as-is, for instance:
+
+```go
+type PetStoreImpl struct {}
+func (*PetStoreImpl) GetPets(w http.ResponseWriter, r *http.Request) {
+ // Implement me
+}
+
+func SetupHandler() {
+ var myApi PetStoreImpl
+
+ http.Handle("/", Handler(&myApi))
+}
+```
+
+ |
+
net/http1.22+ net/httpIris