ddoronin

ddoronin

How to generate Swagger/OpenAPI specification for Phoenix REST

Hey folks! I’m trying to find a library to generate swagger/openapi specification based on elixir code (typed structs or type definitions). Unfortunately I can’t find anything…

I’m new in elixir and phoenix. I want to generate swagger/openapi describing REST API. This should be a common problem, I’m wondering how others tackle it.

Marked As Solved

Also Liked

ityonemo

ityonemo

if you’re willing to wait a few weeks, my company is releasing an open-source framework for OpenAPI that takes a document-centric view (it uses the OpenAPI schema as a central source of truth and there are no additional DSLs to learn).

We just pushed it to a private repo for one release worth of validating in prod before fully open sourcing it.

Note that this is not exactly what you are working for, it’s more like how Go and C# developers do it… But I’m convinced that going from the schema to code is the “correct way” of doing things, instead of going from code (comments, annotations, etc) to schema.

ityonemo

ityonemo

So I kept trying to contact my former boss but he said nothing, so I’ll have to rewrite it. There will be some news on this front soon.

ityonemo

ityonemo

Just to follow up on this thread, Apical has now been published on hex.pm

Last Post!

ityonemo

ityonemo

Just to follow up on this thread, Apical has now been published on hex.pm

Where Next?

Popular in Questions Top

rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list. ...
New
hariharasudhan94
Lets say I have map like this fetching from my database %{"_id" => #BSON.ObjectId<58eb1a7a9ad169198c3dXXXX>, "email" => ...
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Harrisonl
We have an ECS cluster with 4 services, where each task joins a single cluster, via discovery ECS discovery service. Currently when I de...
New

Other popular topics Top

Qqwy
Update: How to use the Blogs & Podcasts section You can post links to your blog posts or podcasts either in one of the Official Blog...
3271 130286 1222
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
AngeloChecked
What learn first? Rust or Elixir Hi Elixir community! I’m here because i want learn a new language. I’m a junior developer and mainly i ...
New
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New
AstonJ
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New

We're in Beta

About us Mission Statement