README.md
# OpenApiTypesense
Restful client for Typesense with adherence to Open API spec 3 (formerly Swagger)
[](https://hex.pm/packages/open_api_typesense)
[](https://hexdocs.pm/open_api_typesense)
[](https://hexdocs.pm/open_api_typesense/license.html)
[](https://typesense.org/docs/27.1/api)
[](https://coveralls.io/github/jaeyson/open_api_typesense?branch=main)
## TODO
- Custom Http client adapter (currently [`Req`](https://hexdocs.pm/req))
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `open_api_typesense` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:open_api_typesense, "~> 0.2"}
]
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/open_api_typesense>.