Skip to content

Streamline generation of OpenAPI documentation #182

@ivosh

Description

@ivosh

There is another repository with Java controller interfaces. The interfaces are annotated with io.swagger.v3.oas.annotations annotations and then built into a JAR file and published to a maven repository.

This repository hosts OpenAPI documentation groups. For every OpenAPI documentation group, there is a maven module which uses springdoc-openapi-maven-plugin to create the corresponding OpenAPI documentation yaml file. springdoc-openapi-maven-plugin needs to have an already-prepared Spring Boot application because it generates OpenAPI yaml file during the integration-test phase. Every module contains dummy implementations of a subset of the Java controller interfaces.

The existing approach requires to manually create a minimalistic Spring Boot application boilerplate for every OpenAPI documentation group. This is impractical copy&paste and hard to maintain.

The inputs for every OpenAPI documentation group are:

  • JAR file (a maven dependency) with the annotated controller interfaces
  • list of controller interface names which should be part of that group

Metadata

Metadata

Assignees

Labels

enhancementImprovement to existing functionality

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions