kylelw23

kylelw23

Hi Elixir community,
My phoenix application already set up the swagger and it’s up and running.
I specified swagger specification for /get and it works well

 swagger_path :index do
    get("/api/campaigns")
    description("List of campaigns")
    response(code(:ok), "Success")
  end

but when I tried specify swagger for /post, I got stuck at its parameter() although I followed the documents, I installed latest PhoenixSwagger from its github branch
I still can’t specify the parameter right
I tried this

swagger_path :create do
    post("/api/campaigns")
    description("Create a campaign")
    PhoenixSwagger.Path.Parameter(:name, :start_date, :end_date, :budget, :hashtags, :team_id, :description)
    response(code(:ok), "Success")
  end

with parenthesis and not with parenthesis
or this

swagger_path :create do
    post("/api/campaigns")
    description("Create a campaign")
    parameter(:name, :start_date, :end_date, :budget, :hashtags, :team_id, :description)
    response(code(:ok), "Success")
  end

and I got this error for the two above code:

lib/kernel/parallel_compiler.ex:346: anonymous fn/5 in Kernel.ParallelCompiler.spawn_workers/7

How can I get the parameter right ? Thank you

Showing Posts 1 to 1

daskycodes

daskycodes

With phoenix_swagger you probably want to refer to the Swagger 2.0 Documentation. You have to define a request body as described here: Describing Request Body | Swagger Docs.

Did you check out the example they provide in the repository?

https://github.com/xerions/phoenix_swagger/blob/250d7c79459227095c0eb5c12237afb1b21b6477/examples/simple/lib/simple_web/controllers/user_controller.ex#L93

This could look like the following example

  swagger_path :create do
    post("/api/campaigns")
    description("Create a campaign")

    parameter(:campaign, :body, Schema.ref(:campaign), "Campaign Attributes")

    response(200, "Success")
  end

Additionally you have to define the :campaign schema. Here you can make use of the swagger_definitions/0 function, which you can also add into the same controller:

  def swagger_definitions do
    %{
      campaign:
        swagger_schema do
          title("Campaign")
          description("A campaign.")

          properties do
            data(
              Schema.new do
                properties do
                  name(:string, "Campaign name", required: true)

                  start_time(:string, "Start time of the campaign.",
                    required: true,
                    format: "date-time"
                  )

                  id(:string, "Auto generated ID of type binary_id", required: false)
                end
              end
            )
          end

          example(%{
            campaign: %{
              name: "Marketing 101",
              start_time: "2030-07-01T21:00:00Z"
            }
          })
        end
    }
  end
— All posts loaded —

Where Next? Top

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 94592 917
New
cblavier
Hey there, It’s been more than a year since we started using LiveView as our main UI library and building a whole library of UI componen...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
heathen
Quite interesting article Google brought me. Didn’t find any mentions about it here. What do you think in general? Would you use togethe...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
budgie
A little off-topic, but I feel like people here have a good head on their shoulders. I used to be quite good at making software. Was luc...
New
axelson
Hi there! :wave: @frigidcode and I (but mostly him) have been running an Elixir Book club, we’re almost done with Designing Elixir Syste...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
georgeguimaraes
Just published claude-code-elixir, a plugin marketplace for Claude Code with Elixir support. These are the plugins I’ve been using for my...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews