Home

Guides

If you are new to Ring/Compojure, you should check out the following guides:

• Ring wiki
• Compojure Wiki

The old (bloated) README, with lot's of stuff in (TODO: rewrite into separate pages here):

• Building Documented Apis

2.0.0 Guides (WIP)

• Schema & Spec Coercion
• Going Async
• Inline Help
• Migration to Compojure-api 2.0.0+

Specific topics

• Tutorial
• Apis & options
• Endpoints
• Routing
• Middleware
• Swagger integration
• Swagger aware File-uploads
• Validation and coercion
• Resources & Liberator
• Component integration
• Exception handling
• Serving static resources
• Authentication and authorization
• Testing api endpoints
• Creating your own metadata handlers
• Running in Google App Engine
• Migration from Swagger 1.2 to 2.0 (Compojure-api 0.20.0+)
• Migration to Compojure-api 1.0.0+

Example projects

• Official example projects
• authenticated-compojure-api - An example compojure-api app demonstrating basic and token authentication using buddy
• role-based-auth-api - An example compojure-api app demonstrating custom token authentication and role-guarded routes

Other resources

• Using Buddy with Compojure-api: https://gist.github.com/Deraen/ef7f65d7ec26f048e2bb