// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-07-24

package src

// ControllerEntry
// is a controller entry.
//
//	entry := &ControllerEntry{
//	   Controller: &controllers.Controller{},
//	   Middlewares: {"name-1", "ExampleMiddleware"},
//	   Prefix: "v1/users",
//	}
type ControllerEntry struct {
	// Controller
	// is a pointer instance of any type.
	//
	// Example:
	//   entry.Controller = &controllers.Controller{}
	Controller any

	// Middlewares
	// is a list name for http request. Each name must be registered in
	// annotation middlewares.
	//
	// Example:
	//   entry.Middlewares = []string{
	//       "name-1",
	//       "ExampleMiddleware",
	//   }
	Middlewares []string

	// Prefix
	// is a route prefix for http request like follows.
	//
	// Example:
	//   entry.Prefix = "/user"
	//   entry.Prefix = "/v1/user"
	Prefix string
}