self(auto)- documenting encoders and decoders
Go to file
2022-11-08 16:24:31 +09:00
.github upgrade ci 2021-11-06 12:47:58 +01:00
autodocodec Released autodocodec-servant-multipart 2022-10-06 19:49:57 +02:00
autodocodec-api-usage autodocodec-servant-multipart 2022-10-04 16:15:10 +02:00
autodocodec-openapi3 Add Discriminated unions 2022-07-21 16:11:24 +02:00
autodocodec-schema Add Discriminated unions 2022-07-21 16:11:24 +02:00
autodocodec-servant-multipart Released autodocodec-servant-multipart 2022-10-06 19:49:57 +02:00
autodocodec-swagger2 Add Discriminated unions 2022-07-21 16:11:24 +02:00
autodocodec-yaml Add Discriminated unions 2022-07-21 16:11:24 +02:00
nix autodocodec-servant-multipart 2022-09-20 00:59:49 +02:00
.gitignore trying a thing 2021-10-20 17:59:50 +02:00
.hlint.yaml autodocodec-servant-multipart 2022-09-20 00:59:49 +02:00
ci.nix build with more warnings on ci 2022-06-28 13:52:54 +02:00
default.nix Trying to set up CI 2021-10-24 19:21:59 +02:00
LICENSE license in root dir too 2021-11-19 23:05:14 +01:00
README.md Fix a typo in README 2022-11-08 16:24:31 +09:00
shell.nix build with more warnings on ci 2022-06-28 13:52:54 +02:00
stack.yaml autodocodec-servant-multipart 2022-09-20 00:59:49 +02:00
TODO.smos autodocodec-nix todo 2022-09-20 00:42:10 +02:00

Autodocodec

Autodocodec is short for "self(auto)- documenting encoder and decoder".

In short: You write a single instance, of the 'Codec' type-class, for your type, and you get:

See the golden test directory directory for example outputs.

Features

  • ✓ Correct-by-construction encoding and decoding, without generating code.
  • ✓ Generate automatically-correct documentation from code.
  • ✓ Support for recursive types.

State of this project

This project is ready to try out!

data Example = Example
  { exampleTextField :: !Text,
    exampleIntField :: !Int
  }
  deriving stock (Show, Eq, Generic)
  deriving
    ( FromJSON, -- <- FromJSON instance for free.
      ToJSON, -- <- ToJSON instance for free.
      Swagger.ToSchema, -- <- Swagger schema for free.
      OpenAPI.ToSchema -- <- OpenAPI schema for free.
    )
    via (Autodocodec Example)

instance HasCodec Example where
  codec =
    object "Example" $
      Example
        <$> requiredField "text" "documentation for the text field" .= exampleTextField
        <*> requiredField "int" "documentation for the int field" .= exampleIntField

Tests

While we don't provide any actual guarantees, we do have tests for the following properties that we would like to maintain: