Function Example

codegen/generator/example.go:16–87

Example iterates through the roots and returns files that implement an example service, server, and client.

(genpkg string, roots []eval.Root)

// Example iterates through the roots and returns files that implement an
// example service, server, and client.
func Example(genpkg string, roots []eval.Root) ([]*codegen.File, error) {
	var files []*codegen.File
	for _, root := range roots {
		r, ok := root.(*expr.RootExpr)
		if !ok {
			continue // could be a plugin root expression
		}

		// Create service data
		services := service.NewServicesData(r)
		for _, s := range r.Services {
			service.SetUserTypeImports(genpkg, services.Get(s.Name))
		}

		// example service implementation
		if fs := service.ExampleServiceFiles(genpkg, r, services); len(fs) != 0 {
			files = append(files, fs...)
		}

		// example interceptors implementation
		if fs := service.ExampleInterceptorsFiles(genpkg, r, services); len(fs) != 0 {
			files = append(files, fs...)
		}

		// server main
		if fs := example.ServerFiles(genpkg, r, services); len(fs) != 0 {
			files = append(files, fs...)
		}

		// CLI main
		if fs := example.CLIFiles(genpkg, r); len(fs) != 0 {
			files = append(files, fs...)
		}

		// HTTP
		if len(r.API.HTTP.Services) > 0 {
			httpServices := httpcodegen.NewServicesData(services, r.API.HTTP)
			if fs := httpcodegen.ExampleServerFiles(genpkg, httpServices); len(fs) != 0 {
				files = append(files, fs...)
			}
			if fs := httpcodegen.ExampleCLIFiles(genpkg, httpServices); len(fs) != 0 {
				files = append(files, fs...)
			}
		}

		// JSON-RPC
		if len(r.API.JSONRPC.Services) > 0 {
			jsonrpcServices := httpcodegen.NewServicesData(services, &r.API.JSONRPC.HTTPExpr)
			if fs := jsonrpccodegen.ExampleServerFiles(genpkg, jsonrpcServices, files); len(fs) > 0 {
				files = append(files, fs...)
			}
			if fs := jsonrpccodegen.ExampleCLIFiles(genpkg, jsonrpcServices); len(fs) > 0 {
				files = append(files, fs...)
			}
		}

		// GRPC
		if len(r.API.GRPC.Services) > 0 {