Skip to content
Clojure rest api used to demonstrate usage of the Clojure ecosystem for an Ippon Blog Article
Clojure Shell
Branch: master
Clone or download
Matthieu SAUBOUA-BENELUZ
Matthieu SAUBOUA-BENELUZ doc: updated readme with swagger ui url
Latest commit 2b7f229 Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources ragtime migrations now in place Aug 27, 2017
src/clojure_rest
test
.gitignore
.travis.yml
LICENSE
README.md
project.clj Changed default port Sep 11, 2017
swagger_screenshot.png

README.md

clojure-simple-api

Build Status Coverage Status Dependencies Status

This application is a simple demonstration api used for an ippon-article about Clojure. It demonstrates usage of compojure, ring, cheshire, mock, schema ...

Prerequisites

You will need Leiningen 2.0.0 or above installed. See the dependencies status above for more info on libraries status.

Testing

To launch tests for this application, run :

lein test

To test coverage, the project uses the Cloverage plugin, just launch :

lein cloverage

If you want to launch the linter, use the following command :

lein eastwood

Running

Before running the server for the first time, don't forget to run the following command :

lein migrate

To start a web server for the application, run:

lein ring server

Then, to access the swagger ui, go to http://localhost:8080/api-docs/

The application resorts to an h2 database for both testing and running, since it is just a demonstration. You don't need to start a database or anything, everything is stored temporarily in the resources/env/db folder.

Packaging

To package this application for production, use the following command :

lein ring uberjar

However do not forget to :

  • Add production paths for resources to project.clj
  • Add a production folder to the project in resources, containing corresponding configuration files

Quick look

License

Apache 2.0 License

You can’t perform that action at this time.