https://github.com/foxcapades/swrv

Yet another Golang HTTP framework
https://github.com/foxcapades/swrv

Last synced: 5 days ago
JSON representation

Yet another Golang HTTP framework

• Host: GitHub
• URL: https://github.com/foxcapades/swrv
• Owner: Foxcapades
• License: mit
• Created: 2023-09-30T13:30:48.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-01T20:13:03.000Z (about 1 year ago)
• Last Synced: 2024-10-17T01:18:54.534Z (20 days ago)
• Language: Go
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.adoc
  • License: license

Awesome Lists containing this project

README

        
= SWeRVe

Yet another Go HTTP framework.

[source, go]

----

import "github.com/foxcapades/swrv/pkg/swrv"

----

A simple way to setup an HTTP server with request and response filtering.

.Simple Setup

[source, go]

----

type Response struct {

  Message string `json:"message"`

}

func main() {

  swrv.NewServer("0.0.0.0", 8080).

    WithObjectSerializers(swrv.NewDefaultJSONObjectSerializer()).

    WithControllers(

      swrv.NewController("/hello/{name}", swrv.RequestHandlerFunc(func(request swrv.Request) swrv.Response {

        return swrv.NewResponse().

          WithBody(Response{fmt.Sprintf("Hello %s!", request.URIParam("name"))})

      })),

    ).

    Start(nil)

}

----

More examples available at https://github.com/Foxcapades/swrv-examples[].

== Concepts

=== Controllers

A controller is a collection of filters and a request handler that process an

incoming HTTP request and return a response.  The core of a controller is the

request handler which is intended to perform the core logic of the request

processing.

=== Request Filters

A request filter is a middleware layer that processes a request before it

reaches the controller, optionally halting the request from further processing

and forcing an early response.  Examples of request filters include

authentication layers, request-id generation, request timing starts.

If a request filter returns `nil`, the request will continue processing, moving

on to either the next registered request filter, or the controller.  If a

request filter returns a non-`nil` response, that response will be returned to

the calling HTTP client with no further request processing; this response will,

however, be processed by <>.

Request filters are executed in the order they are registered, with global

request filters being applied before controller specific request filters.

=== Response Filters

A response filter is a middleware layer that processes a response before it is

returned to the HTTP client.  Response filters may modify or entirely replace

the response before it goes out the door.  Response filters are required to

return a `Response` value.  Examples of response filters include request timing

ends and response code loggers.

If a response filter returns `nil` the response to the client will be a 500

error.

Response filters are always hit.

Response filters are executed in the order they are registered with global

response filters being applied _after_ controller-specific response filters.

=== Object Serializers

An object serializer is a type that is used to serialize non-stream response

objects to be returned to the HTTP client.  For example, a JSON object

serializer may be used to encode response body values as JSON.

If a response body is an `io.Reader` or `io.ReadCloser` the value will be

streamed directly to the client with no processing.  If the response body is

an `io.ReadCloser` it will be closed when streaming is completed.

In addition to serializing data, object serializers may choose which objects or

responses they apply to.  So, for example, an object serializer may look for a

`Content-Type` header and choose to process the response only if the header

value is `application/json`.

Swrv includes a JSON serializer by default which may be used with an optional

response filter, or may be used to serialize all non-stream response bodies.