swagger-hal's Introduction

Swagger HAL Module - OBSOLETE

=========

Obsolete notice

This project is obsolete. The recommended replacements are available at https://github.com/openapi-tools/swagger-hal.

This module is intended to ensure correct documentation generated by Swagger when the Jackson HAL module is being used for generating HAL JSON output.

Status

Module is considered production ready.

Usage

The Swagger module will be automatically discovered by Swagger when present in the classpath.

Caveat: Using the Swagger Maven Plugin

Note: Using the Nykredit Swagger Maven plugin will also solve this issue.

The Swagger Maven Plugin manipulates the extensions of Swagger and does not call upwards in the ModelConverter chain. Therefor it is necessary to configure the Swagger HAL Module explicitly. The following illustrates the necessary configuration.

<plugin>
    <groupId>com.github.kongchen</groupId>
    <artifactId>swagger-maven-plugin</artifactId>
    <version>${swagger-maven-plugin.version}</version>
    <dependencies>
        <dependency>
            <groupId>dk.nykredit.swagger</groupId>
            <artifactId>swagger-hal</artifactId>
            <version>${swagger-hal.version}</version>
        </dependency>
    </dependencies>
    <configuration>
        <apiSources>
            <apiSource>
                <!-- add the model converter -->
                <modelConverters>
                    <modelConverter>dk.nykredit.swagger.HALModelConverter</modelConverter>
                </modelConverters>
            </apiSource>
        </apiSources>
    </configuration>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Recommend Projects