loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/server/petstore/haskell-yesod
History
William Cheng 654f62ce3c
Prepare 7.11.0 (#20130) 
* Revert "prepare 7.10.0 release (#20128)"

This reverts commit 12dfe8fe74a1515d1e69e00df9abe4128aa44160.

* update to 7.11.0-SNAPSHOT, update samples

* update docs
2024-11-18 20:15:29 +08:00
..
.openapi-generator
Prepare 7.11.0 (#20130)
2024-11-18 20:15:29 +08:00
app
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
config
Haskell: JSON Query parameters (#18047)
2024-03-12 15:35:18 +08:00
src
Haskell: JSON Query parameters (#18047)
2024-03-12 15:35:18 +08:00
static
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
test
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
.dir-locals.el
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
.gitignore
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
.openapi-generator-ignore
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
package.yaml
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00
pom.xml
[haskell-yesod] Better code format, mark generator as beta (#10222)
2021-08-22 11:31:38 +08:00
README.md
Fix thousands of spelling typos (#10272)
2021-08-28 22:58:24 +08:00
stack.yaml
New server generator for Haskell/Yesod (#10193)
2021-08-21 23:57:18 +08:00

README.md

Haskell Setup

  1. If you haven't already, install Stack
    • On POSIX systems, this is usually curl -sSL https://get.haskellstack.org/ | sh
  2. Install the yesod command line tool: stack install yesod-bin --install-ghc
  3. Build libraries: stack build

If you have trouble, refer to the Yesod Quickstart guide for additional detail.

Development

Start a development server with:

stack exec -- yesod devel

As your code changes, your site will be automatically recompiled and redeployed to localhost.

Tests

stack test --flag open-api-petstore:library-only --flag open-api-petstore:dev

(Because yesod devel passes the library-only and dev flags, matching those flags means you don't need to recompile between tests and development, and it disables optimization to speed up your test compile times).

Documentation

  • Read the Yesod Book online for free
  • Check Stackage for documentation on the packages in your LTS Haskell version, or search it using Hoogle. Tip: Your LTS version is in your stack.yaml file.
  • For local documentation, use:
    • stack haddock --open to generate Haddock documentation for your dependencies, and open that documentation in a browser
    • stack hoogle <function, module or type signature> to generate a Hoogle database and search for your query
  • The Yesod cookbook has sample code for various needs

Getting Help