Structure

VaporDocCMiddleware

Vapor middleware that serves files from a DocC archive.

Declaration

struct VaporDocCMiddleware

Topics

Initializers

init(archivePath: URL, redirectRoot: String?, redirectMissingTrailingSlash: Bool)
Create a new middleware that serves files from the DocC archive at archivePath.

Instance Properties

let archivePath: URL
The path to the DocC archive.
let redirectMissingTrailingSlash: Bool
When true the /documentation and /tutorials endpoints will be redirected to /documentation/ and /tutorials/ respectively.
let redirectRoot: String?
The path to redirect a request to the root (/) to. When nil no redirection will occur.

Instance Methods

func respond(to: Request, chainingTo: Responder) -> EventLoopFuture<Response>

Default Implementations

Middleware Implementations

Relationships

Conforms To

  • Vapor.Middleware