add example that shows accessing request headers (#374)

dropshot/examples/request-headers.rs

@@ -0,0 +1,56 @@
+// Copyright 2022 Oxide Computer Company
+
+//! Example use of Dropshot with request headers
+//!
+//! The headers accessed here will not be recorded as inputs in the OpenAPI
+//! spec.  This is not currently supported out-of-the-box with Dropshot, but it
+//! could be done by implementing you're own `Extractor` that pulls the headers
+//! out, similar to what's done here.
+//!
+//! This example is based on the "basic.rs" one.  See that one for more detailed
+//! comments on the common code.
+
+use dropshot::endpoint;
+use dropshot::ApiDescription;
+use dropshot::ConfigDropshot;
+use dropshot::ConfigLogging;
+use dropshot::ConfigLoggingLevel;
+use dropshot::HttpError;
+use dropshot::HttpResponseOk;
+use dropshot::HttpServerStarter;
+use dropshot::RequestContext;
+use std::sync::Arc;
+
+#[tokio::main]
+async fn main() -> Result<(), String> {
+    let config_dropshot: ConfigDropshot = Default::default();
+    let config_logging =
+        ConfigLogging::StderrTerminal { level: ConfigLoggingLevel::Info };
+    let log = config_logging
+        .to_logger("example-basic")
+        .map_err(|error| format!("failed to create logger: {}", error))?;
+    let mut api = ApiDescription::new();
+    api.register(example_api_get_header_generic).unwrap();
+
+    let api_context = ();
+    let server =
+        HttpServerStarter::new(&config_dropshot, api, api_context, &log)
+            .map_err(|error| format!("failed to create server: {}", error))?
+            .start();
+    server.await
+}
+
+/// Shows how to access a header that's not part of the OpenAPI spec
+#[endpoint {
+    method = GET,
+    path = "/header-example-generic",
+}]
+async fn example_api_get_header_generic(
+    rqctx: Arc<RequestContext<()>>,
+) -> Result<HttpResponseOk<String>, HttpError> {
+    let request = rqctx.request.lock().await;
+    // Note that clients can provide multiple values for a header.  See
+    // http::HeaderMap for ways to get all of them.
+    let header = request.headers().get("demo-header");
+    Ok(HttpResponseOk(format!("value for header: {:?}", header)))
+}