goaを使った開発TIPS@六本木一丁目
1 like913 views
The document discusses goa, a framework for building REST APIs in Go. It provides an overview of goa's design slangage (DSL) for defining APIs, resources, media types, and code generation tools. Examples are given of defining an Account media type and Account resource using the DSL. The document also mentions using goagen to generate API, client, and Swagger code from the DSL definitions.
goaを使った開発TIPS@六本木一丁目
- 5. #goastudy
- 6. goa
- 7. goa
- 9. • GET /:id • Header token • :id •
- 10. • GET /:id • Header token • :id •
- 11. • GET /:id • Header token • :id •
- 12. model
- 13. • GET /:id • Header token • :id •
- 14. • GET /:id • Header token • :id •
- 15. OSS
- 17. goa
- 18. VOYAGE GROUP 18
- 19. goa@
- 23. v2 v1.2 v5.7
- 26. • • •
- 27. • 3 • 5 • 1
- 29. View
- 32. • •
- 34. goa
- 37. DSL
- 38. • app: • main: main • client: API Go • js: JavaScript API • swagger: API Swagger • schema: API Hyper-schema JSON • gen: • controller: • bootstrap: app main client swagger
- 39. • app: • main: main • client: API Go • js: JavaScript API • swagger: API Swagger • schema: API Hyper-schema JSON • gen: • controller: • bootstrap: app main client swagger
- 40. API Swagger
- 41. swagger
- 42. Swagger
- 43. Swagger API mock
- 44. goa+swagger • goa swagger • swagger •
- 45. REST
- 49. Swagger
- 52. • DSL •
- 55. • goa • • •
- 56. • goa • • •
- 57. goa goa Go WAF goadesign/goa-celler goadesign/examples
- 58. • goa • • •
- 59. Github issue
- 60. • goa • • •
- 61. go goa
- 63. go goa
- 64. • goa • • •
- 65. goa • • • data
- 66. goa • • • data ※
- 68. • • • DSL • •
- 69. • • • DSL • •
- 71. . !"" app/ !"" client/ !"" design/ !"" main.go !"" public/ !"" store/ !"" tool/ !"" account.go <— .go !"" bottle.go !"" health.go !"" js.go !"" public.go #"" swagger.go
- 72. Controller repo: github.com/goadesign/goa-cellar controllers .go package controllers main.go mount controllers
- 73. . !"" app/ !"" client/ !"" main.go !"" controllers <— $ !"" account.go $ !"" bottle.go $ !"" health.go $ !"" js.go $ !"" public.go $ #"" swagger.go !"" design/ !"" public/ #"" tool/
- 74. • • • DSL • •
- 75. DSL
- 76. goa
- 77. # gen: clean generate clean: @rm -rf app @rm -rf client @rm -rf tool @rm -rf public/swagger @rm -rf public/schema @rm -rf public/js @rm -f cellar generate: @goagen app -d github.com/goadesign/goa-cellar/design @goagen swagger -d github.com/goadesign/goa-cellar/design -o public @goagen schema -d github.com/goadesign/goa-cellar/design -o public @goagen client -d github.com/goadesign/goa-cellar/design @goagen js -d github.com/goadesign/goa-cellar/design -o public
- 78. • • • DSL • •
- 79. DSL package design import ( . "github.com/goadesign/goa/design" . "github.com/goadesign/goa/design/apidsl" ) var _ = API("appengine", func() { Title("The appengine example") Description("A simple appengine example") Contact(func() { Name("goa team") Email("admin@goa.design") URL("http://goa.design") }) License(func() { Name("MIT") URL("https://github.com/goadesign/goa/blob/master/LICENSE") }) Docs(func() { Description("goa guide") URL("http://goa.design/getting-started.html") }) Host("localhost:8080") Scheme("http") BasePath("/") Origin("*", func() { Methods("GET") MaxAge(600) Credentials() }) }) var ExampleMediaType = MediaType("application/vnd.example+json", func() { Description("example MediaType") Attributes(func() {
- 80. design
- 81. goa-celler • api_definition.go API • media_types.go MediaType • resources.go Resource • user_types.go Type
- 84. package design import ( . "github.com/goadesign/goa/design" . "github.com/goadesign/goa/design/apidsl" ) // Account is the account resource media type. var Account = MediaType("application/vnd.account+json", func() { Description("A tenant account") Attributes(func() { Attribute("id", Integer, "ID of account", func() { Example(1) }) Attribute("href", String, "API href of account", func() { Example("/accounts/1") }) Attribute("name", String, "Name of account", func() { Example("test") }) Attribute("created_at", DateTime, "Date of creation") Attribute("created_by", String, "Email of account owner", func() { Format("email") Example("me@goa.design") }) Required("id", "href", "name", "created_at", "created_by") }) View("default", func() { Attribute("id") Attribute("href") Attribute("name") Attribute("created_at") Attribute("created_by") })
- 86. design !"" api_definition.go !"" medias <- MediaType $ !"" accounts.go $ #"" bottles.go #"" resources <- Resource !"" accounts.go #"" bottles.go
- 88. Resource package resources <— resources import ( . “github.com/hoge/foo/design/constant" <— import "github.com/hoge/foo/design/media" <— import . "github.com/goadesign/goa/design" . "github.com/goadesign/goa/design/apidsl" ) var _ = Resource("accounts", func() { BasePath(“/accounts") // media.hoge DefaultMedia(media.accountsMedia) Action("create", func() { // }) })
- 89. • • • DSL • •
- 90. . !"" app/ !"" client/ !"" controllers/ !"" design/ !"" main.go !"" public/ !"" swagger/ #"" tool/
- 91. . !"" app/ !"" client/ !"" controllers/ !"" design/ !"" main.go !"" public/ !"" swagger/ #"" tool/
- 92. DSL DSL ※
- 94. . !"" app/ !"" client/ !"" controllers/ !"" design/ !"" main.go !"" public/ !"" swagger/ #"" tool/ gitignore
- 98. • • • DSL • •
- 100. goa
- 104. CI
- 107. • Swagger • • issue •
- 108. goa go goa