nathanjohnson320 / charon

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Charon

What is this?

Charon is a module attribute that runs a validator before executing the function below.

The goal is to abstract away pre-request validation on phoenix controller functions but there might be other use cases for it that I'm not thinking of.

Installation

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

def deps do
  [
    {:charon, "~> 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/charon.

TODO

  • OpenAPI generation
  • Tests generation
  • Generic validation functions?

About

License:MIT License


Languages

Language:Elixir 100.0%