phiz71/vertx-swagger


Swagger integration in Eclipse Vert.X world. A dynamic Vert.X router, configured with a swagger file and a swagger-codegen plugin to generate a server stub.

Download


Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"
        
    

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]
        
    

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.phiz71:vertx-swagger:1.6.0'
	}
	dependencies {
		implementation("com.github.phiz71:vertx-swagger:1.6.0")
	}
	<dependency>
	    <groupId>com.github.phiz71</groupId>
	    <artifactId>vertx-swagger</artifactId>
	    <version>1.6.0</version>
	</dependency>

                            
    libraryDependencies += "com.github.phiz71" % "vertx-swagger" % "1.6.0"
        
        

                            
    :dependencies [[com.github.phiz71/vertx-swagger "1.6.0"]]
        
        

Readme


⚠️ DEPRECATED This repository is no longer active ⚠️ I should have archived this project a long time ago but it was hard to close my first OSS project on github.

If you were looking for an integration between Eclipse Vert.x and Swagger/OpenAPI, please consider using [Vert.x OpenAPI] https://vertx.io/docs/vertx-web-openapi/java/

Vert.X - Swagger

This project aims to provide a code generator based on Swagger to create web server with Eclipse Vert.X and Vert.X Web. It contains 2 modules:

  • vertx-swagger-router : a generic Router which can be configured with a swagger definition
  • vertx-swagger-codegen : a library which has to be used with Swagger Codegen Generator

Getting started

Here is a blog post that explains how to use these libraries.

Maven :

vertx-swagger-parent :

<dependency>
  <groupId>com.github.phiz71</groupId>
  <artifactId>vertx-swagger-parent</artifactId>
  <version>1.6.0</version>
  <type>pom</type>
</dependency>

vertx-swagger-router :

<dependency>
  <groupId>com.github.phiz71</groupId>
  <artifactId>vertx-swagger-router</artifactId>
  <version>1.6.0</version>
</dependency>

vertx-swagger-codegen :

<dependency>
  <groupId>com.github.phiz71</groupId>
  <artifactId>vertx-swagger-codegen</artifactId>
  <version>1.6.0</version>
</dependency>