github.com/josephspurrier/go-swagger@v0.2.1-0.20221129144919-1f672a142a00/examples/tutorials/todo-list/server-1/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  	"github.com/go-openapi/errors"
    10  	"github.com/go-openapi/runtime"
    11  	"github.com/go-openapi/runtime/middleware"
    12  
    13  	"github.com/go-swagger/go-swagger/examples/tutorials/todo-list/server-1/restapi/operations"
    14  	"github.com/go-swagger/go-swagger/examples/tutorials/todo-list/server-1/restapi/operations/todos"
    15  )
    16  
    17  //go:generate swagger generate server --target ../../server-1 --name TodoList --spec ../swagger.yml --principal interface{}
    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.UseSwaggerUI()
    34  	// To continue using redoc as your UI, uncomment the following line
    35  	// api.UseRedoc()
    36  
    37  	api.JSONConsumer = runtime.JSONConsumer()
    38  
    39  	api.JSONProducer = runtime.JSONProducer()
    40  
    41  	if api.TodosFindTodosHandler == nil {
    42  		api.TodosFindTodosHandler = todos.FindTodosHandlerFunc(func(params todos.FindTodosParams) middleware.Responder {
    43  			return middleware.NotImplemented("operation todos.FindTodos has not yet been implemented")
    44  		})
    45  	}
    46  
    47  	api.PreServerShutdown = func() {}
    48  
    49  	api.ServerShutdown = func() {}
    50  
    51  	return setupGlobalMiddleware(api.Serve(setupMiddlewares))
    52  }
    53  
    54  // The TLS configuration before HTTPS server starts.
    55  func configureTLS(tlsConfig *tls.Config) {
    56  	// Make all necessary changes to the TLS configuration here.
    57  }
    58  
    59  // As soon as server is initialized but not run yet, this function will be called.
    60  // If you need to modify a config, store server instance to stop it individually later, this is the place.
    61  // This function can be called multiple times, depending on the number of serving schemes.
    62  // scheme value will be set accordingly: "http", "https" or "unix".
    63  func configureServer(s *http.Server, scheme, addr string) {
    64  }
    65  
    66  // The middleware configuration is for the handler executors. These do not apply to the swagger.json document.
    67  // The middleware executes after routing but before authentication, binding and validation.
    68  func setupMiddlewares(handler http.Handler) http.Handler {
    69  	return handler
    70  }
    71  
    72  // The middleware configuration happens before anything, this middleware also applies to serving the swagger.json document.
    73  // So this is a good place to plug in a panic handling middleware, logging and metrics.
    74  func setupGlobalMiddleware(handler http.Handler) http.Handler {
    75  	return handler
    76  }