openapi.go

package codegen

import (
	"encoding/json"
	"path/filepath"
	"text/template"

	"gopkg.in/yaml.v2"

	"goa.design/goa/v3/codegen"
	"goa.design/goa/v3/expr"
	"goa.design/goa/v3/http/codegen/openapi"
)

// OpenAPIFiles returns the files for the OpenAPIFile spec of the given HTTP API.
func OpenAPIFiles(root *expr.RootExpr) ([]*codegen.File, error) {
	// Only create a OpenAPI specification if there are HTTP services.
	if len(root.API.HTTP.Services) == 0 {
		return nil, nil
	}

	jsonPath := filepath.Join(codegen.Gendir, "http", "openapi.json")
	yamlPath := filepath.Join(codegen.Gendir, "http", "openapi.yaml")
	var (
		jsonSection *codegen.SectionTemplate
		yamlSection *codegen.SectionTemplate
	)
	{
		spec, err := openapi.NewV2(root, root.API.Servers[0].Hosts[0])
		if err != nil {
			return nil, err
		}
		jsonSection = &codegen.SectionTemplate{
			Name:    "openapi",
			FuncMap: template.FuncMap{"toJSON": toJSON},
			Source:  "{{ toJSON .}}",
			Data:    spec,
		}
		yamlSection = &codegen.SectionTemplate{
			Name:    "openapi",
			FuncMap: template.FuncMap{"toYAML": toYAML},
			Source:  "{{ toYAML .}}",
			Data:    spec,
		}
	}

	return []*codegen.File{
		{
			Path:             jsonPath,
			SectionTemplates: []*codegen.SectionTemplate{jsonSection},
		},
		{
			Path:             yamlPath,
			SectionTemplates: []*codegen.SectionTemplate{yamlSection},
		},
	}, nil
}

func toJSON(d interface{}) string {
	b, err := json.Marshal(d)
	if err != nil {
		panic("openapi: " + err.Error()) // bug
	}
	return string(b)
}

func toYAML(d interface{}) string {
	b, err := yaml.Marshal(d)
	if err != nil {
		panic("openapi: " + err.Error()) // bug
	}
	return string(b)
}