Package org.apache.clusterbr.zupportl5.processor

Class OpenApiDocGeneratorBase

java.lang.Object

org.apache.clusterbr.zupportl5.processor.OpenApiDocGeneratorBase

Direct Known Subclasses:

HtmlSwaggerDocGenerator, OpenApiJsonDocGenerator

@Component
public class OpenApiDocGeneratorBase
extends Object

UML Diagrams:

Since:

2024-1108

Author:

arcbrth@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
OpenApiDocGeneratorBase()

Method Summary

Modifier and Type	Method	Description
protected List<Class<?>>	getClassesInPackage(String packageName)
protected String	getHttpVerbFromMethod(Method method)
protected String	getPathFromMethod(Method method)
protected boolean	isHttpMethodAnnotatedWithHttpVerb(Method method)
protected String	loadTemplate(String templatePath)
protected String	removeTrailingSlash(String endpoint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected static final org.slf4j.Logger logger

Constructor Details

OpenApiDocGeneratorBase

public OpenApiDocGeneratorBase()

Method Details

getClassesInPackage

protected List<Class<?>> getClassesInPackage(String packageName)
                                      throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

isHttpMethodAnnotatedWithHttpVerb

protected boolean isHttpMethodAnnotatedWithHttpVerb(Method method)

getHttpVerbFromMethod

protected String getHttpVerbFromMethod(Method method)

getPathFromMethod

protected String getPathFromMethod(Method method)

loadTemplate

protected String loadTemplate(String templatePath)
                       throws IOException

Throws:

IOException

removeTrailingSlash

protected String removeTrailingSlash(String endpoint)