Skip to content
/ tie Public

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

License

Notifications You must be signed in to change notification settings

scarf-sh/tie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

efcc040 · Mar 1, 2024
Feb 28, 2023
Jun 20, 2022
Apr 7, 2023
Sep 8, 2023
Feb 7, 2024
Mar 1, 2024
Nov 3, 2022
Feb 15, 2022
Jun 12, 2022
Sep 8, 2023
Mar 1, 2024
Apr 7, 2023
Jun 12, 2022
Jun 13, 2022
Feb 22, 2022
Feb 27, 2022
Nov 4, 2022

Repository files navigation

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.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published