Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 2.01 KB

README.md

File metadata and controls

23 lines (14 loc) · 2.01 KB
Raw

OPEN API functionality for Factom blockchain

Build Status License

Uses OpenApi description from De Facto as basis for connecting to Factom blockchain. This repository contains a collection of utilities needed to work with Open API

  • factom-oapi-server - folder with OpenAPI server re-implemented in Haskell, contains one-to-one translation from DeFacto's OpenApi server implementation with addition for several methods
  • factom-oapi-client - folder with OpenAPi client for Haskell
  • factom-oapi-type - types that we share between Haskell server and Haskell client and keep clean code
  • factom-oapi-generated - folder with additional clients that are generated from Haskell server implementation and Open APi definitions. Includeds factom-elm-client.yaml, factom-purescript-client.yaml

Solution

  • This system extends OpenApi specification from De Facto with addition of multiple endpoints. Our goal to have one-to-one mapping with RPC client which allow easier integrations with web-applications which usually follor REST pattern.

  • We use Haskell because of brilliant type system that provide additional test layer by reducing specific classes of bugs that typial for other language. Type inference allows to detect incoherences at early stages and functional programming approaches gives ability to work easily with null-values and conditional responses..

  • As an RPC connector system uses Haskell RPC client - api-rpc-factom which also uses types for additional correctness.

Uses OpenApi description from DeFacto for connecting to Factom blockchain in a more easier way.

Additionally Provides Swagger client generation for Elm and Purescript.