nebo15/eview

Nebo #15 Views for our Elixir API applications.

Demo

In Nebo #15 we have our own API design manifest, and we trying to follow it.

This package extracts all common patterns and utilities, to remove boilerplate from business-logic services.

Installation

The package can be installed as:

1. Add eview to your list of dependencies in mix.exs:

```elixir
def deps do
  [{:eview, "~> 0.12.1"}]
end
```

2. Ensure eview is started before your application:

```elixir
def application do
  [applications: [:eview]]
end
```

The docs can be found at https://hexdocs.pm/eview.

eview's Issues

Exposing private APIs

CONTAINER_HTTP_HOST is used internally in eview, and starts to being relied upon in libraries out there. Right now this variable along with it's _PORT sister is a private API.

I think exploiting private APIs should rarely, if ever, be the case. CONTAINER_HTTP_HOST must become public in some form, or explicitly discouraged to be relied upon.

Current name also has a potential to clash with an env var from some app in the wild that decides to use eview.

I think a better way to handle this would be:

1. turn HOST/PORT into config values, e.g. :eview_test_host etc. (preferable, IMO),
2. rename CONTAINER_HTTP_HOST into EVIEW_HTTP_TEST_HOST (thus clearly stating that the variable is related to eview)