/awex

Primary LanguageElixirMIT LicenseMIT

AWeX

Simple Elixir wrapper for the AWX API.

Hex Version Hex Docs

CI Status MIT License

📚 Table Of Contents

🚀 Getting Started

If available in Hex, the package can be installed by adding awex to your list of dependencies in mix.exs:

def deps do
  [
    {:awex, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/awex.

⚙️ Configuration

  • (Optional) AWeX comes with AWeX.HTTPClient.Finch configured by default. If you want to use it, you just need to include Finch as a dependency of your app.

AWeX also accepts Hackney out-of-the-box. See Swoosh.HTTPClient.Hackney for details.

If you need to integrate with another HTTP client, it's easy to define a new API client. Follow the AWeX.HTTPClient behaviour and configure AWeX to use it:

config :awex, :http_client, MyApp.HTTPClient

Todo

🔗 Links

🛡️ License

AWeX is licensed under the MIT License - see the LICENSE file for details