Liking cljdoc? Tell your friends :D

Ring

Build Status

Ring is a Clojure web applications library inspired by Python's WSGI and Ruby's Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows web applications to be constructed of modular components that can be shared among a variety of applications, web servers, and web frameworks.

The SPEC file at the root of this distribution provides a complete description of the Ring interface.

Upgrade Notice

From version 1.2.1 onward, the ring/ring-core package no longer comes with the javax.servlet/servlet-api package as a dependency (see issue #89).

If you are using the ring/ring-core namespace on its own, you may run into errors when executing tests or running alternative adapters. To resolve this, include the following dependency in your dev profile:

[javax.servlet/servlet-api "2.5"]

Libraries

  • ring-core - essential functions for handling parameters, cookies and more
  • ring-devel - functions for developing and debugging Ring applications
  • ring-servlet - construct Java servlets from Ring handlers
  • ring-jetty-adapter - a Ring adapter that uses the Jetty webserver

Installation

To include one of the above libraries, for example ring-core, add the following to your :dependencies:

[ring/ring-core "1.10.0"]

To include all of them:

[ring "1.10.0"]

Documentation

Community

Contributing

Please see CONTRIBUTING.md.

Thanks

This project borrows heavily from Ruby's Rack and Python's WSGI; thanks to those communities for their work.

License

Copyright © 2009-2023 Mark McGranaghan, James Reeves & contributors.

Released under the MIT license.

Can you improve this documentation? These fine people already did:
James Reeves, Mark McGranaghan, weavejester, Tero Paloheimo, Audrius & RainerWasserfuhr
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close