OpenApiSpex - OpenAPI / Swagger 3.0 for Plug APIs

mbuhot

Leverage Open Api 3.0 (Swagger) to document, test, validate and explore your Plug and Phoenix APIs.

Generate and serve a JSON Open API (swagger) document from your code
Use the spec to cast request params to well defined schema structs
Validate params against schemas, eliminate bad requests before they hit your controllers
Validate responses against schemas in tests, ensuring your docs are accurate and reliable
Explore the API interactively with with SwaggerUI

Github: GitHub - open-api-spex/open_api_spex: Open API Specifications for Elixir Plug applications · GitHub
Docs: open_api_spex v3.22.3 — Documentation
Hex: open_api_spex | Hex

Integrating with phoenix controllers:

  @spec open_api_operation(atom) :: Operation.t
  def open_api_operation(action), do: apply(__MODULE__, :"#{action}_operation", [])

  @spec show_operation() :: Operation.t
  def show_operation() do
    %Operation{
      tags: ["users"],
      summary: "Show user",
      description: "Show a user by ID",
      operationId: "UserController.show",
      parameters: [
        Operation.parameter(:id, :path, :integer, "User ID", example: 123)
      ],
      responses: %{
        200 => Operation.response("User", "application/json", UserResponse)
      }
    }
  end
  def show(conn, %{"id" => id}) do
    {:ok, user} = MyApp.Users.find_by_id(id)
    json(conn, 200, user)
  end

Cast and validate params:

  plug OpenApiSpex.Plug.Cast
  plug OpenApiSpex.Plug.Validate

  def open_api_operation(action) do
    apply(__MODULE__, :"#{action}_operation", [])
  end

  def create_operation do
    import Operation
    %Operation{
      tags: ["users"],
      summary: "Create user",
      description: "Create a user",
      operationId: "UserController.create",
      parameters: [],
      requestBody: request_body("The user attributes", "application/json", UserRequest),
      responses: %{
        201 => response("User", "application/json", UserResponse)
      }
    }
  end

  def create(conn, request = %UserRequest{user: %User{name: name, email: email, birthday: birthday = %Date{}}}) do
    ...  
end

54 comments

#library #plug #swagger #open_api_spex

20 15753 54

2024-04-29 06:31:21 UTC

Showing Posts 1 to 10

Show Best Posts
Show All (oldest first)
Show All (newest first)

mbuhot

Version 2.3.0 released.
Now supports validating enum string types.

Post #1

lessless

Hi,

Is there way to keep specs in a separate files?

Post #2

mbuhot

@lessless can you elaborate on what you’re looking for?

OpenApiSpex doesn’t support reading external JSON/YAML files, but there is some flexibility in organizing the Elixir code.

Post #3

lessless

Plug application example clarified it. I thought about extracting specs in separate .ex files and importing them later on, but having a module per http action is even better.

Post #4

mbuhot

Version 3.2.0 released.

Lots of internal improvements and some new features thanks to the wonderful contributors, particularly @moxley and the team at Ghost Group / Weedmaps.

Highlights:

Jason library support for JSON serialization
Improved memory usage
Improved error messages and validations
Integrate SwaggerUI with Plug.CSRFProtection

See the changelog for more details.

Post #5

mbuhot

Version 3.4.0 released.

This version is required when using Phoenix 1.4.7+ and the OpenApiSpex.Paths.from_router/1 function.

Highlights:

Open API extensions can be added to the OpenApi document and the Info structs
Server.from_endpoint now uses the Phoenix API instead of the endpoint config to determine the URL
Compatibility with Phoenix 1.4.7 Router modules

Post #6

henry-hz

amazing lib! thanks @mbuhot!
I loved the idea that the controller tests are guaranteeing the API protocol, so when our mobile/web devs (or us) access the swaggerui, they will see a guaranteed documentation

Post #7

lud

In the example the api data is returned by show_operation which is just a function, so you can pull the %Operation{} data from anywhere.

Post #8

moxley

Version 3.5.0 is released!

This version has a lot of changes from the last several months. Highlights:

Ability to import Open API documents into OpenApiSpex, as an alternative to defining specs using using OpenApiSpex’ Elixir syntax.
Experimental support for ExDoc-based operation specs. Use doc tags in your controller to define operations instead of defining callback functions.
Improved Open API compliance and bug fixes for casting and validations
Deprecate the legacy cast & validate implementation for the newer Cast module.

Thank you to @mbuhot for letting me manage the release.

Post #9