Packages

spectral

0.1.0
0.13.0 0.12.0 0.11.0 0.10.0 0.9.2 0.9.1 0.9.0 0.8.2 0.8.1 0.8.0 0.7.0 0.6.0 0.5.1 0.5.0 0.4.0 0.3.2 0.3.1 0.3.0 0.2.0 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Spectral provides type-driven JSON encoding/decoding, JSON Schema generation, and OpenAPI 3.1 specification generation. It uses Elixir's type system to automatically handle serialization based on struct type definitions.

HexDocs

Current section

Files

Jump to
Readme
24 Versions
1 Dependency
Dependants
Files
Activity
spectral lib person.ex
Raw

lib/person.ex 

defmodule Person do

  @moduledoc """

  Example module demonstrating Spectral usage with nested structs.

  """



  defmodule Address do

    @moduledoc """

    Address struct representing a person's address.

    """



    defstruct [:street, :city]



    @type t :: %Address{

            street: String.t(),

            city: String.t()

          }

  end



  defstruct [:name, :age, :address]



  @type t :: %Person{

          name: String.t(),

          age: non_neg_integer() | nil,

          address: Address.t() | nil

        }



  def testdata do

    %Person{name: "Alice", age: 30}

  end



  def testjson do

    ~s({"name":"Alice","age":30})

  end

end