https://github.com/kubukoz/swaggins

[retired] OpenAPI -> Scala model generator I wrote in 2018-2019.
https://github.com/kubukoz/swaggins

cats-effect codegen fs2 metaprogramming openapi scala tagless-final

Last synced: about 1 month ago
JSON representation

[retired] OpenAPI -> Scala model generator I wrote in 2018-2019.

• Host: GitHub
• URL: https://github.com/kubukoz/swaggins
• Owner: kubukoz
• Created: 2018-07-01T22:59:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-29T21:39:13.000Z (almost 6 years ago)
• Last Synced: 2024-12-17T16:47:31.724Z (about 1 month ago)
• Topics: cats-effect, codegen, fs2, metaprogramming, openapi, scala, tagless-final
• Language: Scala
• Homepage:
• Size: 231 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# swagins-cli

> A wizard is never late, Frodo Swaggins.

Swaggins is an opinionated code generator for [OpenAPI](https://github.com/OAI/OpenAPI-Specification).

The idea is to generate client/server code for Scala backends written with http4s, fs2 and circe.

## Limitations

- JSON only, no support for XML (because it's 2018)

## Inspiration

Swaggins borrows heavily from similar tools, most notably [API Builder](https://apibuilder.io/), but with some key differences:

|                  |Apibuilder | Swaggins

|------------------|-----------|-----------------

|Spec hosting      | Remote    | Local or remote

|Generator hosting | Remote    | Local

|Spec format       | Custom    | Standard (OpenApi)

|Execution         | Remote    | Local (CLI)

and more.

Roadmap:

- http4s server generator

- axios client generator

- android (retrofit) client generator

- http4s client generator

## Packaging

`sbt stage` for getting a raw binary, `sbt universal:packageBin` for zipfile