Class: Spikard::OpenApiConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/spikard/config.rb

Overview

OpenAPI 3.1.0 documentation configuration.

Spikard can automatically generate OpenAPI documentation from your routes. When enabled, it serves:

  • Swagger UI at /docs (customizable)

  • Redoc at /redoc (customizable)

  • OpenAPI JSON spec at /openapi.json (customizable)

Security schemes are auto-detected from middleware configuration. Schemas are generated from your route type hints and validation.

Examples:

openapi = OpenApiConfig.new(
  enabled: true,
  title: 'My API',
  version: '1.0.0',
  description: 'A great API built with Spikard',
  contact: ContactInfo.new(
    name: 'API Team',
    email: 'api@example.com',
    url: 'https://example.com'
  ),
  license: LicenseInfo.new(
    name: 'MIT',
    url: 'https://opensource.org/licenses/MIT'
  ),
  servers: [
    ServerInfo.new(url: 'https://api.example.com', description: 'Production'),
    ServerInfo.new(url: 'http://localhost:8000', description: 'Development')
  ]
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: false, title: 'API', version: '1.0.0', description: nil, swagger_ui_path: '/docs', redoc_path: '/redoc', openapi_json_path: '/openapi.json', contact: nil, license: nil, servers: [], security_schemes: {}) ⇒ OpenApiConfig

Returns a new instance of OpenApiConfig.

Parameters:

  • enabled (Boolean) (defaults to: false) —

    Enable OpenAPI generation (default: false for zero overhead)

  • title (String) (defaults to: 'API') —

    API title (default: “API”)

  • version (String) (defaults to: '1.0.0') —

    API version (default: “1.0.0”)

  • description (String, nil) (defaults to: nil) —

    API description (supports Markdown)

  • swagger_ui_path (String) (defaults to: '/docs') —

    Path to serve Swagger UI (default: “/docs”)

  • redoc_path (String) (defaults to: '/redoc') —

    Path to serve Redoc (default: “/redoc”)

  • openapi_json_path (String) (defaults to: '/openapi.json') —

    Path to serve OpenAPI JSON spec (default: “/openapi.json”)

  • contact (ContactInfo, nil) (defaults to: nil) —

    Contact information for the API

  • license (LicenseInfo, nil) (defaults to: nil) —

    License information for the API

  • servers (Array<ServerInfo>) (defaults to: []) —

    List of server URLs for different environments (default: [])

  • security_schemes (Hash<String, SecuritySchemeInfo>) (defaults to: {}) —

    Custom security schemes (auto-detected if not provided)



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/spikard/config.rb', line 316

def initialize(
  enabled: false,
  title: 'API',
  version: '1.0.0',
  description: nil,
  swagger_ui_path: '/docs',
  redoc_path: '/redoc',
  openapi_json_path: '/openapi.json',
  contact: nil,
  license: nil,
  servers: [],
  security_schemes: {}
)
  @enabled = enabled
  @title = title
  @version = version
  @description = description
  @swagger_ui_path = swagger_ui_path
  @redoc_path = redoc_path
  @openapi_json_path = openapi_json_path
  @contact = contact
  @license = license
  @servers = servers
  @security_schemes = security_schemes
end

Instance Attribute Details

#contact ⇒ Object

Returns the value of attribute contact.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def contact
  @contact
end

#description ⇒ Object

Returns the value of attribute description.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def enabled
  @enabled
end

#license ⇒ Object

Returns the value of attribute license.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def license
  @license
end

#openapi_json_path ⇒ Object

Returns the value of attribute openapi_json_path.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def openapi_json_path
  @openapi_json_path
end

#redoc_path ⇒ Object

Returns the value of attribute redoc_path.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def redoc_path
  @redoc_path
end

#security_schemes ⇒ Object

Returns the value of attribute security_schemes.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def security_schemes
  @security_schemes
end

#servers ⇒ Object

Returns the value of attribute servers.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def servers
  @servers
end

#swagger_ui_path ⇒ Object

Returns the value of attribute swagger_ui_path.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def swagger_ui_path
  @swagger_ui_path
end

#title ⇒ Object

Returns the value of attribute title.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def title
  @title
end

#version ⇒ Object

Returns the value of attribute version.



301
302
303
 
# File 'lib/spikard/config.rb', line 301

def version
  @version
end