aackerman/lebowski-api

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# [lebowski.me](http://lebowski.me) [![Build Status](https://travis-ci.org/aackerman/lebowski-api.svg?branch=master)](https://travis-ci.org/aackerman/lebowski-api) [![Code Climate](https://codeclimate.com/github/aackerman/lebowski-api.png)](https://codeclimate.com/github/aackerman/lebowski-api)

A small rails app for serving up information from [The Big Lebowski](http://en.wikipedia.org/wiki/The_Big_Lebowski)

## Routes

```
/api/script
/api/quotes/random
/api/quotes/search?term=that+poor+woman
/api/quotes/:id
/api/lines/search?term=mountain
/api/lines/random
/api/lines/:id
/api/search?term=mountain # alias for /api/quotes/search
```

## Text format

Append `.txt` to several routes to receive a text format

```
/api/quotes/random.txt
/api/quotes/search.txt?term=that+poor+woman
/api/quotes/:id.txt
/api/lines/search.txt?term=mountain
/api/lines/random.txt
/api/lines/:id.txt
/api/search.txt?term=mountain # alias for /api/quotes/search
```

## Random quotes and searching by character name

```
/api/quotes/random.txt?character=Bunny
/api/quotes/random.txt?character=The+Dude
/api/lines/random.txt?character=The+Dude
/api/lines/search.txt?term=objects&character=The+Dude
```

## Using cURL

```bash
$ curl -L http://lebowski.me
```

## CLI client

[lebowski](https://github.com/aackerman/lebowski)

```bash
$ npm i -g lebowski
```

## Author

| [![twitter/_aaronackerman_](http://gravatar.com/avatar/c73ff9c7e654647b2b339d9e08b52143?s=70)](http://twitter.com/_aaronackerman_ "Follow @_aaronackerman_ on Twitter") |
|---|
| [Aaron Ackerman](https://twitter.com/_aaronackerman_) |