JarCasting
JarCasting JarCasting

Shingle

A swagger like at compile time

License

License
GroupId

GroupId

fr.shingle
ArtifactId

ArtifactId

parent
Last Version

Last Version

1.4
Release Date

Release Date
Type

Type

pom
Description

Description

Shingle
A swagger like at compile time
Project URL

Project URL

http://shingle.fr
Source Code Management

Source Code Management

https://github.com/Jbbouille/shingle

Download parent

Filename Size
parent-1.4.pom 8 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/fr.shingle/parent/ -->
<dependency>
    <groupId>fr.shingle</groupId>
    <artifactId>parent</artifactId>
    <version>1.4</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/fr.shingle/parent/
implementation 'fr.shingle:parent:1.4'
// https://jarcasting.com/artifacts/fr.shingle/parent/
implementation ("fr.shingle:parent:1.4")
'fr.shingle:parent:pom:1.4'
<dependency org="fr.shingle" name="parent" rev="1.4">
  <artifact name="parent" type="pom" />
</dependency>
@Grapes(
@Grab(group='fr.shingle', module='parent', version='1.4')
)
libraryDependencies += "fr.shingle" % "parent" % "1.4"
[fr.shingle/parent "1.4"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

  • shingle-core
  • shingle-maven-plugin
  • shingle-annotations

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