fr.shingle:shingle-maven-plugin

A swagger like at compile time

License	The MIT License
Categories	Maven Build Tools
GroupId	fr.shingle
ArtifactId	shingle-maven-plugin
Last Version	1.4
Release Date	Oct 31, 2019
Type	maven-plugin
Description	A swagger like at compile time
Project URL	http://shingle.fr/shingle-maven-plugin

Download shingle-maven-plugin

Filename	Size
shingle-maven-plugin-1.4.pom
shingle-maven-plugin-1.4.jar	9 KB
shingle-maven-plugin-1.4-sources.jar	4 KB
shingle-maven-plugin-1.4-javadoc.jar	22 KB

How to add to project

Apache Maven

<plugin>
    <groupId>fr.shingle</groupId>
    <artifactId>shingle-maven-plugin</artifactId>
    <version>1.4</version>
</plugin>

Dependencies

compile (5)

Group / Artifact	Type	Version
fr.shingle : shingle-core	jar	1.4
org.apache.maven : maven-plugin-api	jar	3.3.9
org.apache.maven : maven-core	jar	3.3.9
com.google.guava : guava	jar	18.0
org.apache.cxf : cxf-bundle-jaxrs	jar	2.7.18

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.4

Project Modules

There are no modules declared in this project.

Shingle

Introduction

Shingle is a library design to build a documentation from annotation, it is similar to Swagger (more lightweight). It can interact with some of the swagger Annotation. It is fast, clean and extensible (as usual with new libraries).

This product was initially designed @Libon.

Shingle code organisation

The shingle repository is divided in 4 parts:

• Core: The entry point of the core of shingle is the class fr.shingle.jaxrs.DocumentationBuilder.
• Shingle-maven-plugin: This a plugin that can be use in java projects in order to build documentation with Maven and Shingle.
• Shingle-UI: The UI.
• Shingle annotations which contains java annotations that you can add tou your project.

Contributors

Main contributors are:

• obourgain
• jmoussa
• jbpetit

Versions

Version
1.4 Oct 31, 2019