scarf-sh/tie
1
1
Fork 0
mirror of https://github.com/scarf-sh/tie.git synced 2024-11-22 10:31:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Tie allows generation of Haskell server stubs from OpenAPI (v 3.x) specifications.
138 Commits 7 Branches 7 Tags 678 KiB
Haskell 99.2%
Nix 0.8%
f40aca5fd9
Go to file
Brady Ouren f40aca5fd9
use Builder.byteString (#57) 
* replace name with Builder.byteString

* bump version

* cabal run tie-tests -- --accept
2024-03-20 17:29:08 -04:00
.github/workflows Revert "upload build artifacts instead of creating releases" 2023-02-28 15:40:43 +01:00
assets Update logo 2022-06-20 12:10:34 +02:00
bin Support x-tie-haskell-name to override field names 2023-04-07 10:47:46 +02:00
example restore compatibility between petstore-example and petstore-api 2023-09-08 12:45:58 +02:00
src Remove usage of Data.Aeson.Parser 2024-02-07 12:57:06 +01:00
test use Builder.byteString (#57) 2024-03-20 17:29:08 -04:00
.gitignore create and upload binaries on tags 2022-11-03 22:53:03 +01:00
cabal.project Use Relude from Hackage again 2022-06-12 14:58:07 +02:00
CHANGELOG.md Initial commit 2022-02-15 11:01:21 +01:00
default.nix Sync default.nix with tie.cabal 2022-06-13 13:37:38 +02:00
LICENSE Cabal file updates 2022-06-12 14:58:07 +02:00
README.md Update README.md 2023-09-08 15:54:58 +02:00
Request.template.hs use Builder.byteString (#57) 2024-03-20 17:29:08 -04:00
Response.template.hs Support x-tie-haskell-name to override field names 2023-04-07 10:47:46 +02:00
scarf-api.yaml Add petstore golden test 2022-02-22 10:34:38 +01:00
shell.nix deveplopment nix shell 2022-02-26 22:49:03 -05:00
tie.cabal use Builder.byteString (#57) 2024-03-20 17:29:08 -04:00

README.md

Tie allows generation of Haskell server stubs from OpenAPI (v 3.x) specifications.

If you are looking for a generator for Haskell client code, check out the Haskell-OpenAPI-Client-Code-Generator project.

Usage

$ tie --help
tie - openapi3 server code generator

Usage: tie [-o|--output DIR] [--module-name MODULE] [--package-name PACKAGE]
           [--extra-package PACKAGE] FILE

  Generate a Haskell server from an OpenAPI3 specification

Available options:
  -o,--output DIR          The directory output (default: "out")
  --module-name MODULE     Name of the generated top level module
                           (default: "OpenAPI")
  --package-name PACKAGE   Name of the generated cabal project
                           (default: "open-api")
  --extra-package PACKAGE  Extra packages to include in the generated cabal
                           project
  FILE                     OpenAPI specification file
  -h,--help                Show this help text

Example

See example/ for the ubiquitous OpenAPI Petstore example.

Installation

Building from source

Below are the steps to install Tie using the Cabal build tool.

First, you need to clone the repository

$ git clone https://github.com/scarf-sh/tie.git
$ cd tie

Then, you need to build it using cabal:

$ cabal build exe:tie

Y ou can install the executable with using:

$ cabal install .

Community & Contact

Feel free to join on us on our community Slack (#tie channel)!

License

This program is under the terms of the Apache License v2.0.

Authors

Tie is originally made and currently sponsored by Scarf among other contributors.