root
API
Generated with
root/org.sigilaris/org.sigilaris.node/org.sigilaris.node.jvm/org.sigilaris.node.jvm.transport.armeria/TapirOpenApiExporter

TapirOpenApiExporter

org.sigilaris.node.jvm.transport.armeria.TapirOpenApiExporter
object TapirOpenApiExporter

Generates and writes OpenAPI specification documents from Tapir endpoint definitions.

Attributes

Source
TapirOpenApiExporter.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def document(title: String, version: String, endpoints: List[AnyEndpoint], enrich: OpenAPI => OpenAPI): OpenAPI

Generates an OpenAPI document from the given Tapir endpoints.

Generates an OpenAPI document from the given Tapir endpoints.

Value parameters

endpoints

Tapir endpoints to document

enrich

optional transformation applied to the generated OpenAPI model

title

API title

version

API version string

Attributes

Returns

the generated OpenAPI specification

Source
TapirOpenApiExporter.scala
def write[F[_] : Sync](config: OpenApiExportConfig, endpoints: List[AnyEndpoint], enrich: OpenAPI => OpenAPI): F[Path]

Generates an OpenAPI document and writes it to disk.

Generates an OpenAPI document and writes it to disk.

Type parameters

F

the effect type

Value parameters

config

export configuration (output path, format, title, version)

endpoints

Tapir endpoints to document

enrich

optional transformation applied to the generated OpenAPI model

Attributes

Returns

the absolute path of the written file

Source
TapirOpenApiExporter.scala
Generated with