JarCasting
JarCasting JarCasting

swaggerify


License

License
Categories

Categories

AWS Container PaaS Providers Swagger Program Interface REST Frameworks
GroupId

GroupId

io.sumislawski.swaggerify
ArtifactId

ArtifactId

swaggerify_2.13
Last Version

Last Version

0.3.2
Release Date

Release Date
Type

Type

jar
Description

Description

swaggerify
swaggerify
Project URL

Project URL

https://github.com/RafalSumislawski/swaggerify
Project Organization

Project Organization

io.sumislawski.swaggerify
Source Code Management

Source Code Management

https://github.com/RafalSumislawski/swaggerify

Download swaggerify_2.13

Filename Size
swaggerify_2.13-0.3.2.pom
swaggerify_2.13-0.3.2.jar 257 KB
swaggerify_2.13-0.3.2-sources.jar 10 KB
swaggerify_2.13-0.3.2-javadoc.jar 1 MB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/io.sumislawski.swaggerify/swaggerify_2.13/ -->
<dependency>
    <groupId>io.sumislawski.swaggerify</groupId>
    <artifactId>swaggerify_2.13</artifactId>
    <version>0.3.2</version>
</dependency>
// https://jarcasting.com/artifacts/io.sumislawski.swaggerify/swaggerify_2.13/
implementation 'io.sumislawski.swaggerify:swaggerify_2.13:0.3.2'
// https://jarcasting.com/artifacts/io.sumislawski.swaggerify/swaggerify_2.13/
implementation ("io.sumislawski.swaggerify:swaggerify_2.13:0.3.2")
'io.sumislawski.swaggerify:swaggerify_2.13:jar:0.3.2'
<dependency org="io.sumislawski.swaggerify" name="swaggerify_2.13" rev="0.3.2">
  <artifact name="swaggerify_2.13" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.sumislawski.swaggerify', module='swaggerify_2.13', version='0.3.2')
)
libraryDependencies += "io.sumislawski.swaggerify" % "swaggerify_2.13" % "0.3.2"
[io.sumislawski.swaggerify/swaggerify_2.13 "0.3.2"]

Dependencies

compile (6)

Group / Artifact Type Version
org.scala-lang : scala-library jar 2.13.5
com.propensive : magnolia_2.13 jar 0.17.0
io.swagger : swagger-models jar 1.6.2
io.swagger : swagger-core jar 1.6.2
org.scala-lang.modules : scala-collection-compat_2.13 jar 2.4.3
org.scala-lang : scala-reflect jar 2.13.5

test (12)

Group / Artifact Type Version
io.swagger : swagger-validator jar 1.0.7
commons-io : commons-io jar 2.8.0
org.slf4j : slf4j-api jar 1.7.30
org.apache.logging.log4j : log4j-api jar 2.14.1
org.apache.logging.log4j : log4j-slf4j-impl jar 2.14.1
com.lmax : disruptor jar 3.4.2
com.typesafe.scala-logging : scala-logging_2.13 jar 3.9.3
io.circe : circe-generic_2.13 jar 0.13.0
io.circe : circe-parser_2.13 jar 0.13.0
io.circe : circe-yaml_2.13 jar 0.13.1
org.specs2 : specs2-core_2.13 jar 4.10.6
org.specs2 : specs2-scalacheck_2.13 jar 4.10.6

Project Modules

There are no modules declared in this project.

Swaggerify

Swaggerify is a library implementing type-class approach to generating swagger files from Scala code.

Swaggerify is heavily inspired by, and based on http4s/rho. Swaggerify is a research towards providing similar features with more compile-time assertions, as well as improving compatibility with the Swagger 2.0/OpenAPI 2.0 specification and client generators.

Design

Swaggerify is designed aroud Swaggerify[T] type-class which provies facilities to generate Swagger model/property/parameter from type T. Swaggerify instances for Algebraic Data Types (ADTs) are derived with magnolia.

Development Status

Building models, properties and parameters from Scala (and Java) types is mostly ready with few minor exceptions. A minimalistic builder for describing routes/paths is under development, although the plan is to eventually replace it with a modified version of rho's DSL. Setup for testing compatibility with specification using swagger-validator is in place. I've done some test with a real-life API model, which I couldn't share here.

License

Swaggerify is licensed under Apache License, Version 2.0 (see LICENSE). Swaggerify contains parts of code from http4s/rho licensed under Apache License, Version 2.0 (see the license of rho: LICENSE.rho)

Versions

Version
0.3.2