View Source Swagdox.Spec (swagdox v0.1.1)

OpenAPI specification.

Summary

Functions

Generates the paths for the specification.

Generates the schemas for the specification.

Generates security schemes for the specification.

Initializes a new OpenAPI specification.

Types

@type t() :: %Swagdox.Spec{
  config: Swagdox.Config.t(),
  info: map(),
  openapi: String.t(),
  paths: [map()],
  schemas: list(),
  security: list(),
  servers: [map()],
  tags: [map()]
}

Functions

@spec generate_paths(t()) :: t()

Generates the paths for the specification.

@spec generate_schemas(t()) :: t()

Generates the schemas for the specification.

Link to this function

generate_security_schemes(spec)

View Source
@spec generate_security_schemes(t()) :: t()

Generates security schemes for the specification.

@spec init(Swagdox.Config.t()) :: t()

Initializes a new OpenAPI specification.

@spec render(t()) :: map()