Springdoc OpenAPI Programmatic Documenation

Allows for defining OpenAPI documentation using code

License	MIT License
Categories	springdoc-openapi Program Interface REST Frameworks
GroupId	com.danielfrak.code
ArtifactId	springdoc-openapi-programmatic-documentation
Last Version	1.0.1
Release Date	Jan 15, 2020
Type	jar
Description	Springdoc OpenAPI Programmatic Documenation Allows for defining OpenAPI documentation using code
Project URL	https://www.code.danielfrak.com
Source Code Management	https://github.com/daniel-frak/Springdoc-OpenAPI-Programmatic-Documentation

Download springdoc-openapi-programmatic-documentation

Filename	Size
springdoc-openapi-programmatic-documentation-1.0.1.pom
springdoc-openapi-programmatic-documentation-1.0.1.jar	7 KB
springdoc-openapi-programmatic-documentation-1.0.1-sources.jar	2 KB
springdoc-openapi-programmatic-documentation-1.0.1-javadoc.jar	397 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.danielfrak.code/springdoc-openapi-programmatic-documentation/ -->
<dependency>
    <groupId>com.danielfrak.code</groupId>
    <artifactId>springdoc-openapi-programmatic-documentation</artifactId>
    <version>1.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.danielfrak.code/springdoc-openapi-programmatic-documentation/
implementation 'com.danielfrak.code:springdoc-openapi-programmatic-documentation:1.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.danielfrak.code/springdoc-openapi-programmatic-documentation/
implementation ("com.danielfrak.code:springdoc-openapi-programmatic-documentation:1.0.1")

Apache Buildr

'com.danielfrak.code:springdoc-openapi-programmatic-documentation:jar:1.0.1'

Apache Ivy

<dependency org="com.danielfrak.code" name="springdoc-openapi-programmatic-documentation" rev="1.0.1">
  <artifact name="springdoc-openapi-programmatic-documentation" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.danielfrak.code', module='springdoc-openapi-programmatic-documentation', version='1.0.1')
)

Scala SBT

libraryDependencies += "com.danielfrak.code" % "springdoc-openapi-programmatic-documentation" % "1.0.1"

Leiningen

[com.danielfrak.code/springdoc-openapi-programmatic-documentation "1.0.1"]

Dependencies

provided (2)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter	jar	2.1.0.RELEASE
io.swagger.core.v3 : swagger-core	jar	2.1.0

test (3)

Group / Artifact	Type	Version
org.junit.jupiter : junit-jupiter-engine	jar	5.5.0
org.mockito : mockito-core	jar	3.2.4
org.mockito : mockito-junit-jupiter	jar	3.2.4

Project Modules

There are no modules declared in this project.

Springdoc OpenAPI Programmatic Documentation library

Introduction

This library is an extension for Springdoc OpenAPI which allows for defining OpenAPI 3.0 schema using code.

However, while it was developed with Springdoc OpenAPI in mind, you can apply this solution to any Spring Boot OpenAPI library based on Spring Core.

Getting Started

1. Add a dependency on springdoc-openapi-programmatic-documentation:

<dependency>
  <groupId>com.danielfrak.code</groupId>
  <artifactId>springdoc-openapi-programmatic-documentation</artifactId>
  <version>1.0.1</version>
</dependency>

2. Inject a ModelDocumentation instance in a @configuration class and use it to add a new schema:

import io.swagger.v3.oas.models.media.Schema;
import org.springframework.context.annotation.Configuration;
import com.danielfrak.code.config.openapi.ModelDocumentation;
import com.danielfrak.code.config.openapi.ModelDocumentation.Model;
import com.danielfrak.code.model.MyValueObject;

@Configuration
public class OpenApiConfig {

    public OpenApiConfig(ModelDocumentation modelDocumentation) {
        modelDocumentation
                .add(new DocumentedModel()
                        .source(MyValueObject.class)
                        .implementation(String.class)
                        .schema(new Schema<>()
                                .example("Example value")
                                .description("Base description")));
    }
}

DocumentedModel fields

• source - the class to document
• implementation - equivalent to the implementation on @io.swagger.v3.oas.annotations.media.Schema
• schema - an io.swagger.v3.oas.models.media.Schema instance to serve as the final schema for the source class

Versions

Version
1.0.1 Jan 15, 2020