io.rxmicro:rxmicro-documentation

The basic module for creation a REST-based microservice documentation.

License

License

GroupId

GroupId

io.rxmicro
ArtifactId

ArtifactId

rxmicro-documentation
Last Version

Last Version

0.9
Release Date

Release Date

Type

Type

jar
Description

Description

The basic module for creation a REST-based microservice documentation.
Project Organization

Project Organization

The RxMicro framework
Source Code Management

Source Code Management

http://github.com/rxmicro/rxmicro/tree/master/rxmicro-documentation

Download rxmicro-documentation

How to add to project

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

Dependencies

compile (2)

Group / Artifact Type Version
io.rxmicro : rxmicro-common jar 0.9
io.rxmicro : rxmicro-http jar 0.9

test (4)

Group / Artifact Type Version
org.junit.jupiter : junit-jupiter-api jar 5.7.0
org.junit.jupiter : junit-jupiter-engine jar 5.7.0
org.junit.jupiter : junit-jupiter-params jar 5.7.0
org.mockito : mockito-junit-jupiter jar 3.6.28

Project Modules

There are no modules declared in this project.

The RxMicro Framework

A modern, JVM-based, full stack framework designed to develop distributed reactive applications that use a microservice architecture.

Java 11 GitHub release (latest SemVer) Maven Central javadoc

codecov Code Quality: Java Total Alerts

Verify on Push Verify and Publish on Release

Requirements

JDK 11 or higher

Verified On

JDK 11 JDK 12 JDK 13 JDK 14 JDK 15

Supported Features

Status of all supported features is available at the Features Table

Latest Releases

GitHub release (latest SemVer)

Documentation

Contributing

Contributions to the RxMicro framework are both welcomed and appreciated. For specific guidelines regarding contributions, please see CONTRIBUTING.md.

Check Lists

See CHECK_LISTS.md.

Code Quality

Spotbugs (https://spotbugs.github.io/)

(Standard spotbugs profile with excludes)

Verify via spotbugs:

mvn --fail-at-end -DskipTests -P spotbugs clean verify

If build failed find Total bugs phrase at the console output...

mvn --fail-at-end -DskipTests -P spotbugs \ 
        -Dspotbugs-maven-plugin.failOnError=false \
                clean verify site site:stage

PMD (https://pmd.github.io/)

(Custom pmd profile with exclude-pmd and exclude-cpd)

Verify via pmd:

mvn --fail-at-end -DskipTests -P pmd clean verify

If build failed find PMD Failure phrase at the console output...

mvn --fail-at-end -DskipTests -P pmd \
        -Dmaven-pmd-plugin.failOnViolation=false \
                clean verify site site:stage

Checkstyle (https://checkstyle.sourceforge.io/)

Verify via checkstyle:

mvn --fail-at-end -DskipTests -P checkstyle clean verify

If build failed find reported by Checkstyle phrase at the console output...

mvn --fail-at-end -DskipTests -P checkstyle \
        -Dmaven-checkstyle-plugin.failOnViolation=false \
                clean verify site site:stage

All tools

Verify via spotbugs, pmd, checkstyle:

mvn --fail-at-end -DskipTests -P spotbugs,pmd,checkstyle clean verify

If build failed find Total bugs, PMD Failure, reported by Checkstyle phrase at the console output...

mvn --fail-at-end -DskipTests -P spotbugs,pmd,checkstyle \
        -Dspotbugs-maven-plugin.failOnError=false \
        -Dmaven-pmd-plugin.failOnViolation=false \
        -Dmaven-checkstyle-plugin.failOnViolation=false \
                clean verify site site:stage

Publish to Maven Central

https://central.sonatype.org/pages/apache-maven.html

https://oss.sonatype.org/#stagingRepositories

Licence

Apache Licence 2.0

Versions

Version
0.9
0.8
0.7.4
0.7.3
0.7.2
0.7.1
0.7
0.6
0.5
0.4.2
0.4.1
0.4
0.3
0.2
0.1