io.rxmicro:rxmicro-documentation

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

License	The Apache Software License, Version 2.0
GroupId	io.rxmicro
ArtifactId	rxmicro-documentation
Last Version	0.9
Release Date	Feb 2, 2021
Type	jar
Description	The basic module for creation a REST-based microservice documentation.
Project Organization	The RxMicro framework
Source Code Management	http://github.com/rxmicro/rxmicro/tree/master/rxmicro-documentation

Download rxmicro-documentation

Filename	Size
rxmicro-documentation-0.9.pom
rxmicro-documentation-0.9.jar	17 KB
rxmicro-documentation-0.9-sources.jar	16 KB
rxmicro-documentation-0.9-javadoc.jar	506 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.rxmicro/rxmicro-documentation/ -->
<dependency>
    <groupId>io.rxmicro</groupId>
    <artifactId>rxmicro-documentation</artifactId>
    <version>0.9</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.rxmicro/rxmicro-documentation/
implementation 'io.rxmicro:rxmicro-documentation:0.9'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.rxmicro/rxmicro-documentation/
implementation ("io.rxmicro:rxmicro-documentation:0.9")

Apache Buildr

'io.rxmicro:rxmicro-documentation:jar:0.9'

Apache Ivy

<dependency org="io.rxmicro" name="rxmicro-documentation" rev="0.9">
  <artifact name="rxmicro-documentation" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.rxmicro', module='rxmicro-documentation', version='0.9')
)

Scala SBT

libraryDependencies += "io.rxmicro" % "rxmicro-documentation" % "0.9"

Leiningen

[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.

Requirements

or higher

Verified On

Supported Features

Status of all supported features is available at the Features Table

Latest Releases

Documentation

• Site
• User Guide
• Javadoc
• Examples
• Release Notes

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/)

• (Custom common checkstyle profile with common-suppressions for all classes)
• (Custom public checkstyle profile with public-api-suppressions for public classes)

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

Versions

Version
0.9 Feb 2, 2021
0.8 Jan 5, 2021
0.7.4 Dec 18, 2020
0.7.3 Dec 14, 2020
0.7.2 Dec 10, 2020
0.7.1 Nov 28, 2020
0.7 Nov 28, 2020
0.6 Oct 6, 2020
0.5 May 27, 2020
0.4.2 May 24, 2020
0.4.1 May 16, 2020
0.4 May 12, 2020
0.3 Apr 26, 2020
0.2 Mar 27, 2020
0.1 Mar 19, 2020