clean

Author: zoov-xavier

builder/builder.go

@@ -157,7 +157,7 @@ func (b *Builder) ClearCache() {
 	b.swagger.Components.Schemas = make(openapi3.Schemas)
 }
 
-func (b *Builder) GenerateJson(ctx context.Context, callbacksObject shared.ChipiCallbacks) ([]byte, error) {
+func (b *Builder) GenerateSwagger(ctx context.Context, callbacksObject shared.ChipiCallbacks) (*openapi3.T, error) {
 
 	swagger := *b.swagger
 	for _, m := range b.methods {
@@ -228,7 +228,15 @@ func (b *Builder) GenerateJson(ctx context.Context, callbacksObject shared.Chipi
 		swagger.Paths.Set(key, value)
 	}
 
-	swagger = b.injectExtraDocumentation(ctx, callbacksObject.ExtraDocumentation(), swagger)
+	return &swagger, nil
+}
+
+func (b *Builder) GenerateJson(ctx context.Context, callbacksObject shared.ChipiCallbacks) ([]byte, error) {
+
+	swagger, err := b.GenerateSwagger(ctx, callbacksObject)
+	if err != nil {
+		return nil, err
+	}
 
 	json, err := swagger.MarshalJSON()
 	if err != nil {

builder/extra_documentation.go

@@ -10,12 +10,10 @@ import (
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/cors"
-	"gopkg.in/yaml.v2"
 
 	_ "embed"
 
 	"github.com/schmurfy/chipi"
-	"github.com/schmurfy/chipi/shared"
 )
 
 //go:embed index.html
@@ -71,21 +69,6 @@ func main() {
 
 	router.Get("/doc.json", api.ServeSchema)
 
-	router.Get("/doc_injection.json", func(w http.ResponseWriter, r *http.Request) {
-		data, err := api.GenerateJson(r.Context(), shared.NewChipiCallbacks(&ExtraDocumentationInterface{}))
-		if err != nil {
-			http.Error(w, err.Error(), http.StatusInternalServerError)
-			return
-		}
-		w.Header().Add("Content-Type", "application/json")
-		_, err = w.Write(data)
-		if err != nil {
-			http.Error(w, err.Error(), http.StatusInternalServerError)
-			return
-		}
-	})
-
-	// router.Get("/doc.json", api.ServeSchema)
 	router.Get("/doc2.json", func(w http.ResponseWriter, r *http.Request) {
 		f, err := os.Open("/tmp/doc.json")
 		if err != nil {
@@ -160,23 +143,3 @@ func main() {
 		panic(err)
 	}
 }
-
-var _ shared.ExtraDocumentationInterface = (*ExtraDocumentationInterface)(nil)
-
-type ExtraDocumentationInterface struct{}
-
-func (e ExtraDocumentationInterface) ExtraDocumentation() *shared.DocumentationInjection {
-	file, err := os.ReadFile("doc.yaml")
-	if err != nil {
-		panic(err)
-	}
-
-	data := shared.DocumentationInjection{}
-
-	err = yaml.Unmarshal([]byte(file), &data)
-	if err != nil {
-		panic(err)
-	}
-
-	return &data
-}

example/doc.yaml

@@ -1,24 +1,30 @@
 package shared
 
-type ComponentsInjection map[string]map[string]FieldInjection
+type SchemasInjection map[string]SchemaInjection
 
 type DocumentationInjection struct {
 	Operations map[string]OperationInjection `yaml:"operations"`
-	Components ComponentsInjection           `yaml:"components"`
+	Schemas    SchemasInjection              `yaml:"schemas"`
 }
 
-type FieldInjection struct {
+type SchemaInjection struct {
+	Properties  map[string]PropertyInjection `yaml:"properties"`
+	Description string                       `yaml:"description"`
+}
+
+type PropertyInjection struct {
 	Description string `yaml:"description"`
 }
 
 type OperationInjection struct {
 	Description string                    `yaml:"description"`
 	Summary     string                    `yaml:"summary"`
-	Params      map[string]ParamInjection `yaml:"params"`
+	Path        map[string]ParamInjection `yaml:"path"`
+	Query       map[string]ParamInjection `yaml:"query"`
+	Header      map[string]ParamInjection `yaml:"header"`
 }
 
 type ParamInjection struct {
 	Description string `yaml:"description"`
 	Example     string `yaml:"example"`
-	Examples    string `yaml:"examples"`
 }

example/main.go

@@ -83,24 +83,19 @@ type SchemaResolverInterface interface {
 type ExtraComponentsAndPathsInterface interface {
 	ExtraComponentsAndPaths() (openapi3.Schemas, openapi3.Paths)
 }
-type ExtraDocumentationInterface interface {
-	ExtraDocumentation() *DocumentationInjection
-}
 
 type ChipiCallbacks struct {
 	FilterRouteInterface
 	FilterFieldInterface
 	EnumResolverInterface
 	SchemaResolverInterface
-	ExtraDocumentationInterface
 	i ChipiCallbackInterface
 }
 
 var _ FilterRouteInterface = (*ChipiCallbacks)(nil)
 var _ FilterFieldInterface = (*ChipiCallbacks)(nil)
 var _ EnumResolverInterface = (*ChipiCallbacks)(nil)
 var _ SchemaResolverInterface = (*ChipiCallbacks)(nil)
-var _ ExtraDocumentationInterface = (*ChipiCallbacks)(nil)
 
 func NewChipiCallbacks(i ChipiCallbackInterface) ChipiCallbacks {
 	return ChipiCallbacks{i: i}
@@ -145,11 +140,3 @@ func (c *ChipiCallbacks) ExtraComponentsAndPaths() (openapi3.Schemas, openapi3.P
 		return nil, openapi3.Paths{}
 	}
 }
-
-func (c *ChipiCallbacks) ExtraDocumentation() *DocumentationInjection {
-	if schemaInterface, hasExtraDoc := c.i.(ExtraDocumentationInterface); c.i != nil && hasExtraDoc {
-		return schemaInterface.ExtraDocumentation()
-	} else {
-		return nil
-	}
-}