mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 18:51:03 +01:00
add versioning example
Former-commit-id: 54c903135d1c2ba1838b47fa419433dbb010c317
This commit is contained in:
parent
c74196c6d7
commit
b8addac888
|
@ -158,6 +158,11 @@ Navigate through examples for a better understanding.
|
||||||
* [per-route](routing/writing-a-middleware/per-route/main.go)
|
* [per-route](routing/writing-a-middleware/per-route/main.go)
|
||||||
* [globally](routing/writing-a-middleware/globally/main.go)
|
* [globally](routing/writing-a-middleware/globally/main.go)
|
||||||
|
|
||||||
|
### Versioning
|
||||||
|
|
||||||
|
- [How it works](https://github.com/kataras/iris/blob/master/versioning/README.md)
|
||||||
|
- [Example](versioning/main.go)
|
||||||
|
|
||||||
### hero
|
### hero
|
||||||
|
|
||||||
- [Basic](hero/basic/main.go)
|
- [Basic](hero/basic/main.go)
|
||||||
|
|
1
_examples/versioning/README.md
Normal file
1
_examples/versioning/README.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Head over to the [kataras/iris/versioning/README.md](https://github.com/kataras/iris/blob/master/versioning/README.md) instead.
|
73
_examples/versioning/main.go
Normal file
73
_examples/versioning/main.go
Normal file
|
@ -0,0 +1,73 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/kataras/iris"
|
||||||
|
"github.com/kataras/iris/versioning"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
app := iris.New()
|
||||||
|
|
||||||
|
examplePerRoute(app)
|
||||||
|
examplePerParty(app)
|
||||||
|
|
||||||
|
// Read the README.md before any action.
|
||||||
|
app.Run(iris.Addr(":8080"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// How to test:
|
||||||
|
// Open Postman
|
||||||
|
// GET: localhost:8080/api/cats
|
||||||
|
// Headers[1] = Accept-Version: "1" and repeat with
|
||||||
|
// Headers[1] = Accept-Version: "2.5"
|
||||||
|
// or even "Accept": "application/json; version=2.5"
|
||||||
|
func examplePerRoute(app *iris.Application) {
|
||||||
|
app.Get("/api/cats", versioning.NewMatcher(versioning.Map{
|
||||||
|
"1": catsVersionExactly1Handler,
|
||||||
|
">= 2, < 3": catsV2Handler,
|
||||||
|
versioning.NotFound: versioning.NotFoundHandler,
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
// How to test:
|
||||||
|
// Open Postman
|
||||||
|
// GET: localhost:8080/api/users
|
||||||
|
// Headers[1] = Accept-Version: "1.9.9" and repeat with
|
||||||
|
// Headers[1] = Accept-Version: "2.5"
|
||||||
|
//
|
||||||
|
// POST: localhost:8080/api/users/new
|
||||||
|
// Headers[1] = Accept-Version: "1.8.3"
|
||||||
|
//
|
||||||
|
// POST: localhost:8080/api/users
|
||||||
|
// Headers[1] = Accept-Version: "2"
|
||||||
|
func examplePerParty(app *iris.Application) {
|
||||||
|
usersAPI := app.Party("/api/users")
|
||||||
|
|
||||||
|
// version 1.
|
||||||
|
usersAPIV1 := versioning.NewGroup(">= 1, < 2")
|
||||||
|
usersAPIV1.Get("/", func(ctx iris.Context) {
|
||||||
|
ctx.Writef("v1 resource: /api/users handler")
|
||||||
|
})
|
||||||
|
usersAPIV1.Post("/new", func(ctx iris.Context) {
|
||||||
|
ctx.Writef("v1 resource: /api/users/new post handler")
|
||||||
|
})
|
||||||
|
|
||||||
|
// version 2.
|
||||||
|
usersAPIV2 := versioning.NewGroup(">= 2, < 3")
|
||||||
|
usersAPIV2.Get("/", func(ctx iris.Context) {
|
||||||
|
ctx.Writef("v2 resource: /api/users handler")
|
||||||
|
})
|
||||||
|
usersAPIV2.Post("/", func(ctx iris.Context) {
|
||||||
|
ctx.Writef("v2 resource: /api/users post handler")
|
||||||
|
})
|
||||||
|
|
||||||
|
versioning.RegisterGroups(usersAPI, versioning.NotFoundHandler, usersAPIV1, usersAPIV2)
|
||||||
|
}
|
||||||
|
|
||||||
|
func catsVersionExactly1Handler(ctx iris.Context) {
|
||||||
|
ctx.Writef("v1 exactly resource: /api/cats handler")
|
||||||
|
}
|
||||||
|
|
||||||
|
func catsV2Handler(ctx iris.Context) {
|
||||||
|
ctx.Writef("v2 resource: /api/cats handler")
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user