README.md

   1 # SWSGI
   2
   3 A set of tools and building blocks for responding to HTTP requests from Swift.
   4
   5 Roughly based on SWSGI from [envoy/Embassy](
   6 https://github.com/envoy/Embassy#whats-swsgi-swift-web-server-gateway-interface)
   7
   8 ## Next Steps
   9 [] unify SWNIOServer with the swsgi data structures
  10 [] add more swsgi data structures based on golang and wsgi
  11 [] swcgi connect it up
  12
  13 # Target Layout
  14
  15 ## swsgi
  16
  17 The main building blocks for generically refering to HTTP requests/responses (and their
  18 components). Additionally defines the swsgi/app type.
  19
  20 Roughly based on SWSGI from [envoy/Embassy](
  21 https://github.com/envoy/Embassy#whats-swsgi-swift-web-server-gateway-interface)
  22 with additional types and inspiration from [allevato/SwiftCGI](https://github.com/allevato/SwiftCGI/)
  23 and
  24 [Alamofire](https://github.com/Alamofire/Alamofire).
  25
  26 ## swcgi
  27
  28 Tools for writing CGI binaries (that respond to a single request via stdin/stdout and
  29 environment variables). Optionally hosting a SWSGI app.
  30
  31 This currently builds as an executable, but someday should probably be a library with
  32 a sample executable.
  33
  34 ## swnioserver
  35
  36 Uses Swift-NIO to run a (persistent) HTTP server that stays resident and responds
  37 to many requests. Optionally hosting a SWSGI app.
  38
  39 Based on the uExpress exampel at https://www.alwaysrightinstitute.com/microexpress-nio2/
  40 by https://github.com/helje5.
  41
  42 # Project TODOs (non-functional-reqs)
  43 [] Setup swift-doc
  44 [] Setup swift-format auto
  45 [] Setup test harness