Add versioning support to swagger generator

Author: raphael

Makefile

@@ -63,7 +63,7 @@ lint:
 	fi
 
 cyclo:
-	@if [ "`gocyclo -over 20 . | grep -v examples/cellar | tee /dev/stderr`" ]; then \
+	@if [ "`gocyclo -over 20 . | grep -v _integration_tests | tee /dev/stderr`" ]; then \
 		echo "^ - Cyclomatic complexity exceeds 20, refactor the code!" && echo && exit 1; \
 	fi
 

goagen/gen_app/generator_test.go

@@ -461,7 +461,7 @@ func MountWidgetController(service *goa.Service, ctrl WidgetController) {
 		rctx.APIVersion = "{{.version}}"{{end}}
 		return ctrl.Get(rctx)
 	}
-	mux.Handle("GET", "/:id", ctrl.MuxHandler("Get", "{{.version}}", h, nil))
+	mux.Handle("GET", "/:id", ctrl.MuxHandler("Get", h, nil))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "Widget"},{{if .version}} goa.KV{"version", "{{.version}}"},{{end}} goa.KV{"action", "Get"}, goa.KV{"route", "GET /:id"})
 }
 `
@@ -517,7 +517,7 @@ func MountWidgetController(service *goa.Service, ctrl WidgetController) {
 		}
 		return ctrl.Get(rctx)
 	}
-	mux.Handle("GET", "/:id", ctrl.MuxHandler("Get", "", h, unmarshalGetWidgetPayload))
+	mux.Handle("GET", "/:id", ctrl.MuxHandler("Get", h, unmarshalGetWidgetPayload))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "Widget"}, goa.KV{"action", "Get"}, goa.KV{"route", "GET /:id"})
 }
 

goagen/gen_app/writers.go

@@ -623,7 +623,7 @@ func Mount{{.Resource}}Controller(service *goa.Service, ctrl {{.Resource}}Contro
 		}
 		{{end}}		return ctrl.{{.Name}}(rctx)
 	}
-{{range .Routes}}	mux.Handle("{{.Verb}}", "{{.FullPath $ver}}", ctrl.MuxHandler("{{$action.Name}}", "{{$ver.Version}}", h, {{if $action.Payload}}{{$action.Unmarshal}}{{else}}nil{{end}}))
+{{range .Routes}}	mux.Handle("{{.Verb}}", "{{.FullPath $ver}}", ctrl.MuxHandler("{{$action.Name}}", h, {{if $action.Payload}}{{$action.Unmarshal}}{{else}}nil{{end}}))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "{{$res}}"},{{if not $ver.IsDefault}} goa.KV{"version", "{{$ver.Version}}"},{{end}} goa.KV{"action", "{{$action.Name}}"}, goa.KV{"route", "{{.Verb}} {{.FullPath $ver}}"})
 {{end}}{{end}}}
 `

goagen/gen_app/writers_test.go

@@ -1075,7 +1075,7 @@ func MountBottlesController(service *goa.Service, ctrl BottlesController) {
 		}
 		return ctrl.List(rctx)
 	}
-	mux.Handle("GET", "/accounts/:accountID/bottles", ctrl.MuxHandler("List", "", h, nil))
+	mux.Handle("GET", "/accounts/:accountID/bottles", ctrl.MuxHandler("List", h, nil))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "Bottles"}, goa.KV{"action", "List"}, goa.KV{"route", "GET /accounts/:accountID/bottles"})
 }
 `
@@ -1091,7 +1091,7 @@ func MountBottlesController(service *goa.Service, ctrl BottlesController) {
 		}
 		return ctrl.List(rctx)
 	}
-	mux.Handle("GET", "/accounts/:accountID/bottles", ctrl.MuxHandler("List", "", h, nil))
+	mux.Handle("GET", "/accounts/:accountID/bottles", ctrl.MuxHandler("List", h, nil))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "Bottles"}, goa.KV{"action", "List"}, goa.KV{"route", "GET /accounts/:accountID/bottles"})
 }
 `
@@ -1115,7 +1115,7 @@ type BottlesController interface {
 		}
 		return ctrl.List(rctx)
 	}
-	mux.Handle("GET", "/accounts/:accountID/bottles", ctrl.MuxHandler("List", "", h, nil))
+	mux.Handle("GET", "/accounts/:accountID/bottles", ctrl.MuxHandler("List", h, nil))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "Bottles"}, goa.KV{"action", "List"}, goa.KV{"route", "GET /accounts/:accountID/bottles"})
 	h = func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
 		rctx, err := NewShowBottleContext(ctx)
@@ -1124,7 +1124,7 @@ type BottlesController interface {
 		}
 		return ctrl.Show(rctx)
 	}
-	mux.Handle("GET", "/accounts/:accountID/bottles/:id", ctrl.MuxHandler("Show", "", h, nil))
+	mux.Handle("GET", "/accounts/:accountID/bottles/:id", ctrl.MuxHandler("Show", h, nil))
 	goa.Info(goa.RootContext, "mount", goa.KV{"ctrl", "Bottles"}, goa.KV{"action", "Show"}, goa.KV{"route", "GET /accounts/:accountID/bottles/:id"})
 }
 `

goagen/gen_swagger/generator.go

@@ -50,47 +50,72 @@ func (g *Generator) Generate(api *design.APIDefinition) (_ []string, err error)
 		}
 	}()
 
-	s, err := New(api)
-	if err != nil {
-		return
-	}
-	b, err := json.Marshal(s)
-	if err != nil {
-		return
-	}
 	swaggerDir := filepath.Join(codegen.OutputDir, "swagger")
 	os.RemoveAll(swaggerDir)
 	if err = os.MkdirAll(swaggerDir, 0755); err != nil {
-		return
+		return nil, err
 	}
 	genfiles = append(genfiles, swaggerDir)
-	swaggerFile := filepath.Join(swaggerDir, "swagger.json")
-	err = ioutil.WriteFile(swaggerFile, b, 0644)
+
+	err = api.IterateVersions(func(ver *design.APIVersionDefinition) error {
+		s, err := New(api, ver)
+		if err != nil {
+			return err
+		}
+		b, err := json.Marshal(s)
+		if err != nil {
+			return err
+		}
+		verDir := swaggerDir
+		if ver.Version != "" {
+			verDir = filepath.Join(swaggerDir, ver.Version)
+			if err = os.MkdirAll(verDir, 0755); err != nil {
+				return err
+			}
+			genfiles = append(genfiles, verDir)
+		}
+		swaggerFile := filepath.Join(verDir, "swagger.json")
+		err = ioutil.WriteFile(swaggerFile, b, 0644)
+		if err != nil {
+			return err
+		}
+		genfiles = append(genfiles, swaggerFile)
+		return nil
+	})
 	if err != nil {
-		return
+		return nil, err
 	}
-	genfiles = append(genfiles, swaggerFile)
 	controllerFile := filepath.Join(swaggerDir, "swagger.go")
 	genfiles = append(genfiles, controllerFile)
 	file, err := codegen.SourceFileFor(controllerFile)
 	if err != nil {
-		return
+		return nil, err
 	}
 	imports := []*codegen.ImportSpec{
 		codegen.SimpleImport("github.com/goadesign/goa"),
 	}
 	file.WriteHeader(fmt.Sprintf("%s Swagger Spec", api.Name), "swagger", imports)
-	file.Write([]byte(swagger))
+	var versions []*design.APIVersionDefinition
+	api.IterateVersions(func(ver *design.APIVersionDefinition) error {
+		versions = append(versions, ver)
+		return nil
+	})
+	err = file.ExecuteTemplate("swagger", swaggerT, nil, map[string]interface{}{"Versions": versions})
+	if err != nil {
+		return nil, err
+	}
 	if err = file.FormatCode(); err != nil {
-		return
+		return nil, err
 	}
 
 	return genfiles, nil
 }
 
-const swagger = `
-// MountController mounts the swagger spec controller under "/swagger.json".
+const swaggerT = `
+// MountController mounts the swagger spec controllers (one per API version) under "/swagger.json".
 func MountController(service *goa.Service) {
-	service.ServeFiles("/swagger.json", "swagger/swagger.json")
+{{range .Versions}}	service{{if .Version}}.Version("{{.Version}}"){{end}}{{/*
+*/}}.ServeFiles("/swagger.json", "swagger/{{if .Version}}{{.Version}}/{{end}}swagger.json")
+{{end}}
 }
 `

goagen/gen_swagger/swagger.go

@@ -278,15 +278,15 @@ type (
 )
 
 // New creates a Swagger spec from an API definition.
-func New(api *design.APIDefinition) (*Swagger, error) {
+func New(api *design.APIDefinition, ver *design.APIVersionDefinition) (*Swagger, error) {
 	if api == nil {
 		return nil, nil
 	}
-	tags, err := tagsFromDefinition(api.Metadata)
+	tags, err := tagsFromDefinition(ver.Metadata)
 	if err != nil {
 		return nil, err
 	}
-	params, err := paramsFromDefinition(api.BaseParams, api.BasePath)
+	params, err := paramsFromDefinition(ver.BaseParams, ver.BasePath)
 	if err != nil {
 		return nil, err
 	}
@@ -298,35 +298,35 @@ func New(api *design.APIDefinition) (*Swagger, error) {
 		}
 	}
 	var consumes []string
-	for _, c := range api.Consumes {
+	for _, c := range ver.Consumes {
 		consumes = append(consumes, c.MIMETypes...)
 	}
 	var produces []string
-	for _, p := range api.Produces {
+	for _, p := range ver.Produces {
 		produces = append(produces, p.MIMETypes...)
 	}
 	s := &Swagger{
 		Swagger: "2.0",
 		Info: &Info{
-			Title:          api.Title,
-			Description:    api.Description,
-			TermsOfService: api.TermsOfService,
-			Contact:        api.Contact,
-			License:        api.License,
-			Version:        "",
+			Title:          ver.Title,
+			Description:    ver.Description,
+			TermsOfService: ver.TermsOfService,
+			Contact:        ver.Contact,
+			License:        ver.License,
+			Version:        ver.Version,
 		},
-		Host:         api.Host,
-		BasePath:     api.BasePath,
+		Host:         ver.Host,
+		BasePath:     ver.BasePath,
 		Paths:        make(map[string]*Path),
-		Schemes:      api.Schemes,
+		Schemes:      ver.Schemes,
 		Consumes:     consumes,
 		Produces:     produces,
 		Parameters:   paramMap,
 		Tags:         tags,
-		ExternalDocs: docsFromDefinition(api.Docs),
+		ExternalDocs: docsFromDefinition(ver.Docs),
 	}
 
-	err = api.IterateResponses(func(r *design.ResponseDefinition) error {
+	err = ver.IterateResponses(func(r *design.ResponseDefinition) error {
 		res, err := responseSpecFromDefinition(s, api, r)
 		if err != nil {
 			return err
@@ -341,6 +341,9 @@ func New(api *design.APIDefinition) (*Swagger, error) {
 		return nil, err
 	}
 	err = api.IterateResources(func(res *design.ResourceDefinition) error {
+		if !res.SupportsVersion(ver.Version) {
+			return nil
+		}
 		return res.IterateActions(func(a *design.ActionDefinition) error {
 			for _, route := range a.Routes {
 				if err := buildPathFromDefinition(s, api, route); err != nil {

goagen/gen_swagger/swagger_test.go

@@ -37,7 +37,7 @@ var _ = Describe("New", func() {
 	JustBeforeEach(func() {
 		err := dslengine.Run()
 		Ω(err).ShouldNot(HaveOccurred())
-		swagger, newErr = genswagger.New(Design)
+		swagger, newErr = genswagger.New(Design, Design.APIVersionDefinition)
 	})
 
 	Context("with a valid API definition", func() {

mux.go

@@ -37,7 +37,7 @@ type (
 
 	// Muxer implements an adapter that given a request handler can produce a mux handler.
 	Muxer interface {
-		MuxHandler(name, version string, hdlr Handler, unm Unmarshaler) MuxHandler
+		MuxHandler(name string, hdlr Handler, unm Unmarshaler) MuxHandler
 	}
 
 	// RootMux is the default VersionMux and ServeMux implementation. It dispatches requests to the