wow-openapi/me.ahoo.wow.openapi

Package-level declarations

Types

AbstractAggregateRouteSpecFactory

abstract class AbstractAggregateRouteSpecFactory : AggregateRouteSpecFactory

AbstractTenantOwnerAggregateRouteSpecFactory

abstract class AbstractTenantOwnerAggregateRouteSpecFactory : AbstractAggregateRouteSpecFactory

AggregateRouteSpec

interface AggregateRouteSpec : RouteSpec

AggregateRouteSpecFactory

interface AggregateRouteSpecFactory : RouteSpecFactory

AggregateRouteSpecFactoryProvider

object AggregateRouteSpecFactoryProvider

BatchResult

data class BatchResult(val afterId: String, val size: Int, val errorCode: String = ErrorInfo.SUCCEEDED, val errorMsg: String = ErrorInfo.SUCCEEDED_MESSAGE) : ErrorInfo

The result of a batch operation.

BatchRouteSpec

interface BatchRouteSpec : AggregateRouteSpec

BatchRouteSpecFactory

abstract class BatchRouteSpecFactory : AbstractAggregateRouteSpecFactory

ComponentRef

interface ComponentRef<C>

DefaultGlobalRouteSpecFactory

class DefaultGlobalRouteSpecFactory : GlobalRouteSpecFactory

GlobalRouteSpecFactory

interface GlobalRouteSpecFactory : RouteSpecFactory

GlobalRouteSpecFactoryProvider

object GlobalRouteSpecFactoryProvider

HeaderRef

class HeaderRef(val name: String, val component: Header) : ComponentRef<Header>

Https

object Https

ParameterRef

class ParameterRef(val name: String, val component: Parameter) : ComponentRef<Parameter>

PathBuilder

class PathBuilder

RequestBodyRef

class RequestBodyRef(val name: String, val component: RequestBody) : ComponentRef<RequestBody>

ResponseRef

class ResponseRef(val name: String, val component: ApiResponse, val code: String = Https.Code.OK) : ComponentRef<ApiResponse>

RouteIdSpec

class RouteIdSpec

RoutePaths

object RoutePaths

RouterSpecs

class RouterSpecs(currentContext: NamedBoundedContext, routes: MutableList<RouteSpec> = mutableListOf()) : MutableList<RouteSpec>

RouteSpec

interface RouteSpec : Identifier

RouteSpecFactory

interface RouteSpecFactory

SchemaRef

class SchemaRef(val name: String, val component: Schema<*>, val schemas: Map<String, Schema<*>> = mapOf(name to component)) : ComponentRef<Schema<*>>

Properties

ID_PATH_VARIABLE

const val ID_PATH_VARIABLE: String

OWNER_PATH_PREFIX

const val OWNER_PATH_PREFIX: String

OWNER_PATH_VARIABLE

const val OWNER_PATH_VARIABLE: String

TENANT_PATH_PREFIX

const val TENANT_PATH_PREFIX: String

TENANT_PATH_VARIABLE

const val TENANT_PATH_VARIABLE: String

Functions

toContent

fun Schema<*>.toContent(name: String = "*/*", customize: (Content) -> Unit = {}): Content

toJsonContent

fun Schema<*>.toJsonContent(customize: (Content) -> Unit = {}): Content

toOperation

fun RouteSpec.toOperation(): Operation

toPathItem

fun List<RouteSpec>.toPathItem(): PathItem