https://github.com/markfchavez/ex_swapi
Starwars API wrapper for Elixir
https://github.com/markfchavez/ex_swapi
Last synced: over 1 year ago
JSON representation
Starwars API wrapper for Elixir
- Host: GitHub
- URL: https://github.com/markfchavez/ex_swapi
- Owner: MarkFChavez
- Created: 2017-08-11T05:35:52.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-19T10:20:07.000Z (almost 9 years ago)
- Last Synced: 2025-02-06T15:53:14.580Z (over 1 year ago)
- Language: Elixir
- Size: 12.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ExSwapi
Wrapper for **The Star Wars API**
## Usage
**ex_swapi** is an Elixir wrapper of [The Star Wars API](http://swapi.co/).
### API
```elixir
ExSwapi.all(:planets)
ExSwapi.find(:planets, 1)
ExSwapi.search(:planets, "jupiter")
```
### TODO (Upcoming features)
Refer to [TODO.md](https://github.com/mrkjlchvz/ex_swapi/blob/master/TODO.md).
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ex_swapi` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ex_swapi, "~> 0.1.0"}]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/ex_swapi](https://hexdocs.pm/ex_swapi).