add postman collection generator support

Author: iesreza

README.MD

@@ -20,6 +20,7 @@ Restify is an application built for the [EVO Framework](https://github.com/getev
   - [Loading Associations](./docs/endpoints.md#loading-associations)
   - [Offset and Limit](./docs/endpoints.md#offset-and-limit)
   - [Select Specific Fields](./docs/endpoints.md#select-specific-fields)
+  - [Postman Collection Generator](./docs/endpoints.md#postman-collection-generator)
   - [Example Postman Collection](./docs/endpoints.md#example-postman-collection)
 - **[Customization](./docs/customization.md)**
   - [Hooks](./docs/customization.md#hooks)

app.go

@@ -6,19 +6,28 @@ import (
 	"github.com/getevo/evo/v2/lib/application"
 	"github.com/getevo/evo/v2/lib/db"
 	"github.com/getevo/evo/v2/lib/db/schema"
+	"github.com/getevo/postman"
 	"math"
 )
 
 var Prefix = "/admin/rest"
 
 var permissionHandler func(permissions Permissions, context *Context) bool
+var collection *postman.Collection
 
 type App struct{}
 
 func (app App) Register() error {
 	if !db.Enabled {
 		return fmt.Errorf("database is not enabled. restify plugin cannot be registered without a running database. please enable the database in your configuration file")
 	}
+	collection = postman.NewCollection("Restify", "")
+
+	if postmanAuthType != "none" {
+		collection.Auth = &postman.Auth{
+			Type: postman.AuthType(postmanAuthType),
+		}
+	}
 	return nil
 }
 
@@ -38,7 +47,10 @@ func (app App) WhenReady() error {
 			resources[idx].Actions[i].RegisterRouter()
 		}
 	}
-	evo.Get(Prefix+"/models", controller.Models)
+	evo.Get(Prefix+"/models", controller.ModelsHandler)
+	if postmanRegistered {
+		evo.Get(Prefix+"/postman", controller.PostmanHandler)
+	}
 	return nil
 }
 

controller.go

@@ -1,11 +1,29 @@
 package restify
 
-import "github.com/getevo/evo/v2"
+import (
+	"github.com/getevo/evo/v2"
+	"github.com/getevo/evo/v2/lib/outcome"
+)
 
 // Controller represents a controller type.
 type Controller struct{}
 
-// Models returns all registered models.
-func (c Controller) Models(request *evo.Request) interface{} {
+// ModelsHandler returns all registered models.
+func (c Controller) ModelsHandler(request *evo.Request) interface{} {
 	return resources
 }
+
+func (c Controller) PostmanHandler(request *evo.Request) any {
+	b, err := collection.ToJson()
+	if err != nil {
+		return err
+	}
+	return outcome.Response{
+		StatusCode:  200,
+		ContentType: "application/json",
+		Data:        b,
+		Headers: map[string]string{
+			"Content-Disposition": "attachment; filename=postman_collection.json",
+		},
+	}
+}

docs/endpoints.md

@@ -122,5 +122,38 @@ This example retrieves only the username and name fields from all records in the
 - **Model Information:** Using `GET /admin/rest/models`, it is possible to get information about all available models.
 
 ---
+#### Postman Collection Generator
+
+Restify enables developers to automatically generate Postman collections without requiring manual input. These collections are thoughtfully structured, providing comprehensive explanations of the API, making it easy for developers to understand and utilize them effectively.
+
+1- Enable Postman Collection Generator
+```golang
+func (app App) Register() error {
+    restify.EnablePostman()
+    restify.SetPostmanAuthorization(restify.AuthTypeHeader, "apikey", "secret") //force apikey and secret authentication in header
+      /*
+      restify.SetPostmanAuthorization(restify.AuthTypeBasic) // force basic authentication on Restify collection
+      restify.SetPostmanAuthorization(AuthTypeNone)
+      restify.SetPostmanAuthorization(AuthTypeBearer)   
+      restify.SetPostmanAuthorization(AuthTypeDigest)   
+      restify.SetPostmanAuthorization(AuthTypeEdgeGrid) 
+      restify.SetPostmanAuthorization(AuthTypeHawk)   
+      restify.SetPostmanAuthorization(AuthTypeOAuth1)   
+      restify.SetPostmanAuthorization(AuthTypeOAuth2)   
+      restify.SetPostmanAuthorization(AuthTypeNTLM)    
+      restify.SetPostmanAuthorization(AuthTypeHeader)
+      */
+	return nil
+}
+```
+
+2- Download Collection
+```bash
+curl -o "./collection.json" "{{ base_path }}/{{ prefix }}/postman" 
+```
+
+
+---
+
 #### Example Postman Collection
 **[Postman Collection](https://github.com/getevo/restify/blob/master/example/example.postman_collection.json)**

example/apps/user/app.go

@@ -11,6 +11,10 @@ type App struct{}
 
 func (app App) Register() error {
 	restify.SetPrefix("/admin/rest")
+	restify.EnablePostman()
+
+	//restify.SetPostmanAuthorization(restify.AuthTypeHeader, "username", "password") //force user and password authentication in header
+	restify.SetPostmanAuthorization(restify.AuthTypeBasic) // force basic authentication on Restify collection
 	db.UseModel(User{}, Order{}, Product{}, Article{})
 	evo.GetDBO().AutoMigrate(Article{}, User{}, Order{}, Product{})
 	return nil