Elixir and parameter validation on APIs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
Research direction
No repository files, tests, or entry points are identified in the issue. Start by reviewing the linked discussions and the goal project, then define the API validation approach and its acceptance criteria before locating implementation work.
Written by the indexing model from the issue text.
Description
JSON schema validation is usually a must when implementing an API.
When the API is simple, you can probably get away with simple validations but when you have multiple possible query or URI parameters, keeping its validation clean and concise helps with readability.
There is some discussion on how to do this with Elixir/Phoenix:
- https://www.reddit.com/r/elixir/comments/m63p21/some_thoughts_around_elixir_json_schema_validator/
- https://elixirforum.com/t/whats-the-standard-for-validating-json-bodies-for-an-api/14837
Using Ecto.Changesets is usually the standard. Although I personally use Changesets for validation on a database level, it might be not the same situation for validation on an API-level, where we might want another set of constraints to be met.
Schemaless changesets can (and should!) be actually used for this. But I feel like this produces a considerable amount of boilerplate code.
With this in mind, I've taken a gander and found goal, which seems to make this process painless and make code much more comprehensible, as errors are returned on an atom-basis.
Just food for thought 🧠
- Dominant language
- JavaScript
- Stars
- 291
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dwyl/technology-stack
-
Running local LLMs OpenAi discuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
dwyl/technology-stack#176 · 1 comment · 3 reactions ·
-
Reactor Opendiscuss elixir technical
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
dwyl/technology-stack#168 · 7 comments ·
-
chore discuss help wanted priority-1 T25m tech-debt technical
Difficulty 4/5 3-5 days Newbie friendliness 35/100
dwyl/technology-stack#179 ·
-
`Antigravity` OpenAi discuss enhancement starter T25m technical
Difficulty 3/5 1-2 days Newbie friendliness 35/100
dwyl/technology-stack#178 · 7 comments ·
-
`DESIGN.md` OpenAi discuss enhancement research T1h
Difficulty 5/5 Over a week Newbie friendliness 30/100
dwyl/technology-stack#177 · 1 reaction ·
All issues in dwyl/technology-stack
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·