github.com/emreu/go-swagger@v0.22.1/examples/todo-list/restapi/configure_todo_list.go (about)

     1  // This file is safe to edit. Once it exists it will not be overwritten
     2  
     3  package restapi
     4  
     5  import (
     6  	"crypto/tls"
     7  	"net/http"
     8  
     9  	errors "github.com/go-openapi/errors"
    10  	runtime "github.com/go-openapi/runtime"
    11  	middleware "github.com/go-openapi/runtime/middleware"
    12  
    13  	"github.com/go-swagger/go-swagger/examples/todo-list/restapi/operations"
    14  	"github.com/go-swagger/go-swagger/examples/todo-list/restapi/operations/todos"
    15  )
    16  
    17  //go:generate swagger generate server --target ../../todo-list --name TodoList --spec ../swagger.yml
    18  
    19  func configureFlags(api *operations.TodoListAPI) {
    20  	// api.CommandLineOptionsGroups = []swag.CommandLineOptionsGroup{ ... }
    21  }
    22  
    23  func configureAPI(api *operations.TodoListAPI) http.Handler {
    24  	// configure the api here
    25  	api.ServeError = errors.ServeError
    26  
    27  	// Set your custom logger if needed. Default one is log.Printf
    28  	// Expected interface func(string, ...interface{})
    29  	//
    30  	// Example:
    31  	// api.Logger = log.Printf
    32  
    33  	api.JSONConsumer = runtime.JSONConsumer()
    34  
    35  	api.JSONProducer = runtime.JSONProducer()
    36  
    37  	// Applies when the "x-todolist-token" header is set
    38  	api.KeyAuth = func(token string) (interface{}, error) {
    39  		return nil, errors.NotImplemented("api key auth (key) x-todolist-token from header param [x-todolist-token] has not yet been implemented")
    40  	}
    41  
    42  	// Set your custom authorizer if needed. Default one is security.Authorized()
    43  	// Expected interface runtime.Authorizer
    44  	//
    45  	// Example:
    46  	// api.APIAuthorizer = security.Authorized()
    47  	if api.TodosAddOneHandler == nil {
    48  		api.TodosAddOneHandler = todos.AddOneHandlerFunc(func(params todos.AddOneParams, principal interface{}) middleware.Responder {
    49  			return middleware.NotImplemented("operation todos.AddOne has not yet been implemented")
    50  		})
    51  	}
    52  	if api.TodosDestroyOneHandler == nil {
    53  		api.TodosDestroyOneHandler = todos.DestroyOneHandlerFunc(func(params todos.DestroyOneParams, principal interface{}) middleware.Responder {
    54  			return middleware.NotImplemented("operation todos.DestroyOne has not yet been implemented")
    55  		})
    56  	}
    57  	if api.TodosFindHandler == nil {
    58  		api.TodosFindHandler = todos.FindHandlerFunc(func(params todos.FindParams, principal interface{}) middleware.Responder {
    59  			return middleware.NotImplemented("operation todos.Find has not yet been implemented")
    60  		})
    61  	}
    62  	if api.TodosUpdateOneHandler == nil {
    63  		api.TodosUpdateOneHandler = todos.UpdateOneHandlerFunc(func(params todos.UpdateOneParams, principal interface{}) middleware.Responder {
    64  			return middleware.NotImplemented("operation todos.UpdateOne has not yet been implemented")
    65  		})
    66  	}
    67  
    68  	api.ServerShutdown = func() {}
    69  
    70  	return setupGlobalMiddleware(api.Serve(setupMiddlewares))
    71  }
    72  
    73  // The TLS configuration before HTTPS server starts.
    74  func configureTLS(tlsConfig *tls.Config) {
    75  	// Make all necessary changes to the TLS configuration here.
    76  }
    77  
    78  // As soon as server is initialized but not run yet, this function will be called.
    79  // If you need to modify a config, store server instance to stop it individually later, this is the place.
    80  // This function can be called multiple times, depending on the number of serving schemes.
    81  // scheme value will be set accordingly: "http", "https" or "unix"
    82  func configureServer(s *http.Server, scheme, addr string) {
    83  }
    84  
    85  // The middleware configuration is for the handler executors. These do not apply to the swagger.json document.
    86  // The middleware executes after routing but before authentication, binding and validation
    87  func setupMiddlewares(handler http.Handler) http.Handler {
    88  	return handler
    89  }
    90  
    91  // The middleware configuration happens before anything, this middleware also applies to serving the swagger.json document.
    92  // So this is a good place to plug in a panic handling middleware, logging and metrics
    93  func setupGlobalMiddleware(handler http.Handler) http.Handler {
    94  	return handler
    95  }