From 1e995552c8fee4aec1f1522ecb2425b22079b10d Mon Sep 17 00:00:00 2001 From: Gani Georgiev Date: Sun, 20 Aug 2023 18:31:56 +0300 Subject: [PATCH] updated apis.Serve godoc --- apis/serve.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/apis/serve.go b/apis/serve.go index f423785e..223cc2e0 100644 --- a/apis/serve.go +++ b/apis/serve.go @@ -37,6 +37,16 @@ type ServeConfig struct { } // Serve starts a new app web server. +// +// NB! The app should be bootstrapped before starting the web server. +// +// Example: +// +// app.Bootstrap() +// apis.Serve(app, apis.ServeConfig{ +// HttpAddr: "127.0.0.1:8080", +// ShowStartBanner: false, +// }) func Serve(app core.App, config ServeConfig) (*http.Server, error) { if len(config.AllowedOrigins) == 0 { config.AllowedOrigins = []string{"*"}