Giter Club home page Giter Club logo

swagger-gradle-plugin's Introduction

swagger-gradle-plugin

Purpose

A plugin to help to generate swagger.json file from annotated Java classes. It is like https://github.com/kongchen/swagger-maven-plugin but for Gradle project.

This project is a wapper for kongchen's swagger-maven-plugin (https://github.com/kongchen/swagger-maven-plugin) to be used from Gradle. Internally it will use a Maven project to generate swagger.json file.

The reason for creating this plugin is because the existing gradle plugin by gigaSproule has one issue (gigaSproule/swagger-gradle-plugin#76) regarding classpath conflicts. Specifically I had one project using log4j (while Gradle uses log4j-over-slf4j) and I got NoSuchMethodError when trying gigaSproule's plugin because log4j-over-slf4j was used when scanning classes (instead of log4j).

Usage

Define a custom task as below, when running "gradle swagger", the swagger.json file will be created. See https://github.com/kongchen/swagger-maven-plugin for more info about title, location, basePath.

plugins {
  id "com.tha2015.swagger-gradle-plugin" version "1.0.0"
}

task swagger(type: swaggergen.SwaggerGenTask) {
	title = "Demo Docs"
	location = "com.example.demo"
	basePath = "/demo-api"
	jsonTargetPath = "${project.buildDir}/swagger"
	htmlTargetPath = "${project.buildDir}/swagger/swagger.html"
	doFirst {new File("${project.buildDir}/swagger").mkdirs()}
}

License

Apache 2 license

swagger-gradle-plugin's People

Contributors

tha2015 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.