Class: Steppe::Service::OpenAPISerializer

Inherits:

Object

• Object
• Steppe::Service::OpenAPISerializer

Defined in:

lib/steppe/service.rb

Overview

A custom serializer that generates the OpenAPI specification in JSON format.

Instance Method Summary

• #initialize(service) ⇒ OpenAPISerializer constructor

  A new instance of OpenAPISerializer.

• #render(conn) ⇒ String

  JSON data.

Constructor Details

#initialize(service) ⇒ OpenAPISerializer

Returns a new instance of OpenAPISerializer.

Parameters:

• service (Steppe::Service) —

  The service instance to generate the OpenAPI spec from.

# File 'lib/steppe/service.rb', line 181

def initialize(service)
  @service = service
end

Instance Method Details

#render(conn) ⇒ String

Returns JSON data.

Parameters:

• conn (Steppe::Result)

Returns:

• (String) —

  JSON data

# File 'lib/steppe/service.rb', line 187

def render(conn)
  spec = Steppe::OpenAPIVisitor.from_request(@service, conn.request)
  JSON.dump(spec)
end