index overview

HTTP API service declaration.

Added in v1.0.0

Table of contents

• exports
  • From “./Api.js”
  • From “./ApiEndpoint.js”
  • From “./ApiGroup.js”
  • From “./ApiRequest.js”
  • From “./ApiResponse.js”
  • From “./ApiSchema.js”
  • From “./Client.js”
  • From “./ClientError.js”
  • From “./ExampleServer.js”
  • From “./HttpError.js”
  • From “./Middlewares.js”
  • From “./MockClient.js”
  • From “./OpenApi.js”
  • From “./Representation.js”
  • From “./Route.js”
  • From “./RouterBuilder.js”
  • From “./Security.js”
  • From “./SwaggerRouter.js”

exports

From “./Api.js”

HTTP API service declaration.

Signature

export * as Api from "./Api.js"

Added in v1.0.0

From “./ApiEndpoint.js”

HTTP endpoint declaration.

Signature

export * as ApiEndpoint from "./ApiEndpoint.js"

Added in v1.0.0

From “./ApiGroup.js”

Api groups.

Signature

export * as ApiGroup from "./ApiGroup.js"

Added in v1.0.0

From “./ApiRequest.js”

HTTP request declaration.

Signature

export * as ApiRequest from "./ApiRequest.js"

Added in v1.0.0

From “./ApiResponse.js”

HTTP response declaration.

Signature

export * as ApiResponse from "./ApiResponse.js"

Added in v1.0.0

From “./ApiSchema.js”

Re-exports all named exports from the “./ApiSchema.js” module as ApiSchema.

Signature

export * as ApiSchema from "./ApiSchema.js"

Added in v1.0.0

From “./Client.js”

This module exposes the client combinator which accepts an Api instance and it generates a client-side implementation. The generated implementation is type-safe and guarantees compatibility of the client and server side.

Signature

export * as Client from "./Client.js"

Added in v1.0.0

From “./ClientError.js”

Models for errors being created on the client side.

Signature

export * as ClientError from "./ClientError.js"

Added in v1.0.0

From “./ExampleServer.js”

The exampleServer function generates a Server implementation based on an instance of Api. The listening server will perform all the request and response validations similarly to a real implementation.

Responses returned from the server are generated randomly using the response Schema.

Signature

export * as ExampleServer from "./ExampleServer.js"

Added in v1.0.0

From “./HttpError.js”

HTTP errors.

Signature

export * as HttpError from "./HttpError.js"

Added in v1.0.0

From “./Middlewares.js”

Mechanism for extendning behaviour of all handlers on the server.

Signature

export * as Middlewares from "./Middlewares.js"

Added in v1.0.0

From “./MockClient.js”

Client implementation derivation for testing purposes.

Signature

export * as MockClient from "./MockClient.js"

Added in v1.0.0

From “./OpenApi.js”

Derivation of OpenApi schema from an instance of Api.

Signature

export * as OpenApi from "./OpenApi.js"

Added in v1.0.0

From “./Representation.js”

Representation is a data structure holding information about how to serialize and deserialize a server response for a given conten type.

Signature

export * as Representation from "./Representation.js"

Added in v1.0.0

From “./Route.js”

Create @effect/platform/Http/Router Router

Signature

export * as Route from "./Route.js"

Added in v1.0.0

From “./RouterBuilder.js”

Build a Router satisfying an Api.Api.

Signature

export * as RouterBuilder from "./RouterBuilder.js"

Added in v1.0.0

From “./Security.js”

Authentication and authorization.

Signature

export * as Security from "./Security.js"

Added in v1.0.0

From “./SwaggerRouter.js”

Create a router serving Swagger files.

Signature

export * as SwaggerRouter from "./SwaggerRouter.js"

Added in v1.0.0