Speedy-API

Open Api Integration

Speedy Documentation

Speedy comes with api documentation included

Maven Dependency

include speedy api documentation dependency, speedy will not override any other api documentation, just add it own api docs

<dependency>
    <groupId>com.github.silentsamurai</groupId>
    <artifactId>spring-boot-starter-speedy-api</artifactId>
    <version>3.1.4</version>
</dependency>

also include the open api ui as well

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.4</version>
</dependency>

create an open api customizer so that speedy can add api documentation.

@Configuration
public class SpeedyConfig implements ISpeedyConfiguration {

    ...

    @Bean
    public OpenApiCustomizer customizer(SpeedyOpenApiCustomizer speedyOpenApiCustomizer) {
        return speedyOpenApiCustomizer::generate;
    }

    ...
}