Restful Development¶
路由注册¶
通过路由函数URLPatterns定义API route¶
基于go-restful,拥有它全部的API定义能力,可参考go-restful的readme来确认
type DummyResource struct {
}
func (r *DummyResource) Sayhello(b *restful.Context) {
id := b.ReadPathParameter("userid")
b.Write([]byte(id))
}
//URLPatterns helps to respond for corresponding API calls
func (r *DummyResource) URLPatterns() []restful.Route {
return []restful.Route{
{Method: http.MethodGet, Path: "/sayhello/{userid}", ResourceFunc: r.Sayhello,
Returns: []*restful.Returns{{Code: 200}}},
}
}
Open API 文档管理¶
go chassis可以自动生成Open API2.0的文档,通过编写restful.Route结构的各个属性,可以丰富Open API文档内容 文档自动生成后,可以通过2种方式查看
- 会被注册到service center中,可以通过服务id与schema id进行查询,schema id为微服务名 /v4/{project}/registry/microservices/{serviceId}/schemas/{schemaId}
- 本地http服务启动后,可以在/apidocs.json路径查看文档,也可以在本地进程运行目录下的conf/schema文件夹下找到
路由分组¶
相同资源的多个路由可能会具备同样的路由前缀,这时候你可以使用路由分组来避免重复的路由前缀
type DummyResource struct {
}
//GroupPath returns group path will auto
func (r *DummyResource) GroupPath() string {
return "/demo"
}
func (r *DummyResource) Sayhello(b *restful.Context) {
id := b.ReadPathParameter("userid")
b.Write([]byte(id))
}
func (r *DummyResource) Panic(b *restful.Context) {
panic("panic msg")
}
//URLPatterns helps to respond for corresponding API calls
func (r *DummyResource) URLPatterns() []restful.Route {
return []restful.Route{
// will register path:/demo/sayhello
{Method: http.MethodGet, Path: "/sayhello", ResourceFunc: r.Sayhello,
Returns: []*restful.Returns{{Code: 200}}},
// will register path:/demo/sayhelloagain
{Method: http.MethodGet, Path: "/sayhelloagain", ResourceFunc: r.Sayhello,
Returns: []*restful.Returns{{Code: 200}}},
}
}