Derive documentation from javadoc. Fixes #38.

Author: bnasslahsen

pom.xml

@@ -60,6 +60,7 @@
 		<module>springdoc-openapi-groovy</module>
 		<module>springdoc-openapi-ui</module>
 		<module>springdoc-openapi-webflux-ui</module>
+		<module>springdoc-openapi-javadoc</module>
 	</modules>
 
 	<properties>
@@ -76,6 +77,7 @@
 		<javax.jws-api.version>1.1</javax.jws-api.version>
 		<jjwt.version>0.9.1</jjwt.version>
 		<spring-native.version>0.10.1</spring-native.version>
+		<therapi-runtime-javadoc.version>0.12.0</therapi-runtime-javadoc.version>
 	</properties>
 
 	<dependencyManagement>

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -76,6 +76,7 @@
 import org.springdoc.core.ActuatorProvider;
 import org.springdoc.core.GenericParameterService;
 import org.springdoc.core.GenericResponseService;
+import org.springdoc.core.JavadocProvider;
 import org.springdoc.core.MethodAttributes;
 import org.springdoc.core.OpenAPIService;
 import org.springdoc.core.OperationService;
@@ -302,7 +303,7 @@ protected synchronized OpenAPI getOpenApi() {
 			LOGGER.info("Init duration for springdoc-openapi is: {} ms",
 					Duration.between(start, Instant.now()).toMillis());
 		}
-		else{
+		else {
 			LOGGER.debug("Fetching openApi document from cache");
 			openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI());
 		}
@@ -341,6 +342,8 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 			operationMap = pathItem.readOperationsMap();
 		}
 
+		JavadocProvider javadocProvider = operationParser.getJavadocProvider();
+
 		for (RequestMethod requestMethod : requestMethods) {
 			Operation existingOperation = getExistingOperation(operationMap, requestMethod);
 			Method method = handlerMethod.getMethod();
@@ -353,6 +356,10 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 
 			MethodAttributes methodAttributes = new MethodAttributes(springDocConfigProperties.getDefaultConsumesMediaType(), springDocConfigProperties.getDefaultProducesMediaType(), methodConsumes, methodProduces, headers);
 			methodAttributes.setMethodOverloaded(existingOperation != null);
+			//Use the javadoc return if present
+			if (javadocProvider != null) {
+				methodAttributes.setJavadocReturn(javadocProvider.getMethodJavadocReturn(handlerMethod.getMethod()));
+			}
 
 			if (reqMappingClass != null) {
 				methodAttributes.setClassConsumes(reqMappingClass.consumes());
@@ -395,6 +402,13 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 			ApiResponses apiResponses = responseBuilder.build(components, handlerMethod, operation, methodAttributes);
 			operation.setResponses(apiResponses);
 
+			// get javadoc method description
+			if (javadocProvider != null) {
+				String description = javadocProvider.getMethodJavadocDescription(handlerMethod.getMethod());
+				if (!StringUtils.isEmpty(description) && StringUtils.isEmpty(operation.getDescription()))
+					operation.setDescription(description);
+			}
+
 			Set<io.swagger.v3.oas.annotations.callbacks.Callback> apiCallbacks = AnnotatedElementUtils.findMergedRepeatableAnnotations(method, io.swagger.v3.oas.annotations.callbacks.Callback.class);
 
 			// callbacks
@@ -506,12 +520,12 @@ protected void calculatePath(RouterOperation routerOperation) {
 				operation.getParameters().stream()
 						.filter(parameter -> StringUtils.isEmpty(parameter.get$ref()))
 						.forEach(parameter -> {
-							if (parameter.getSchema() == null)
-								parameter.setSchema(new StringSchema());
-							if (parameter.getIn() == null)
-								parameter.setIn(ParameterIn.QUERY.toString());
-						}
-				);
+									if (parameter.getSchema() == null)
+										parameter.setSchema(new StringSchema());
+									if (parameter.getIn() == null)
+										parameter.setIn(ParameterIn.QUERY.toString());
+								}
+						);
 			PathItem pathItemObject = buildPathItem(requestMethod, operation, operationPath, paths);
 			paths.addPathItem(operationPath, pathItemObject);
 		}
@@ -687,7 +701,7 @@ public static boolean containsResponseBody(HandlerMethod handlerMethod) {
 		ResponseBody responseBodyAnnotation = AnnotationUtils.findAnnotation(handlerMethod.getBeanType(), ResponseBody.class);
 		if (responseBodyAnnotation == null)
 			responseBodyAnnotation = AnnotationUtils.findAnnotation(handlerMethod.getMethod(), ResponseBody.class);
-		return responseBodyAnnotation!=null;
+		return responseBodyAnnotation != null;
 	}
 
 

springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java

@@ -236,6 +236,8 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 		Map<String, io.swagger.v3.oas.annotations.Parameter> parametersDocMap = getApiParameters(handlerMethod.getMethod());
 		Components components = openAPI.getComponents();
 
+		JavadocProvider javadocProvider = operationService.getJavadocProvider();
+
 		for (MethodParameter methodParameter : parameters) {
 			// check if query param
 			Parameter parameter;
@@ -252,6 +254,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 			if (parameterDoc != null) {
 				if (parameterDoc.hidden() || parameterDoc.schema().hidden())
 					continue;
+
 				parameter = parameterBuilder.buildParameterFromDoc(parameterDoc, components, methodAttributes.getJsonViewAnnotation());
 				parameterInfo.setParameterModel(parameter);
 			}
@@ -261,15 +264,31 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 				// Merge with the operation parameters
 				parameter = GenericParameterService.mergeParameter(operationParameters, parameter);
 				List<Annotation> parameterAnnotations = Arrays.asList(methodParameter.getParameterAnnotations());
-				if (isValidParameter(parameter))
+				if (isValidParameter(parameter)) {
+					// Add param javadoc
+					if (StringUtils.isBlank(parameter.getDescription()) && javadocProvider != null) {
+						String paramJavadocDescription = javadocProvider.getParamJavadoc(handlerMethod.getMethod(), pName);
+						if (!StringUtils.isBlank(paramJavadocDescription)) {
+							parameter.setDescription(paramJavadocDescription);
+						}
+					}
 					applyBeanValidatorAnnotations(parameter, parameterAnnotations);
+				}
 				else if (!RequestMethod.GET.equals(requestMethod)) {
 					if (operation.getRequestBody() != null)
 						requestBodyInfo.setRequestBody(operation.getRequestBody());
 					requestBodyService.calculateRequestBodyInfo(components, methodAttributes,
 							parameterInfo, requestBodyInfo);
+					// Add requestBody javadoc
+					if (StringUtils.isBlank(requestBodyInfo.getRequestBody().getDescription()) && javadocProvider != null) {
+						String paramJavadocDescription = javadocProvider.getParamJavadoc(handlerMethod.getMethod(), pName);
+						if (!StringUtils.isBlank(paramJavadocDescription)) {
+							requestBodyInfo.getRequestBody().setDescription(paramJavadocDescription);
+						}
+					}
 					applyBeanValidatorAnnotations(requestBodyInfo.getRequestBody(), parameterAnnotations, methodParameter.isOptional());
 				}
+
 				customiseParameter(parameter, parameterInfo);
 			}
 		}

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java

@@ -168,6 +168,11 @@ public void buildGenericResponse(Components components, Map<String, Object> find
 							springDocConfigProperties.getDefaultProducesMediaType(), controllerAdviceInfoApiResponseMap);
 					//calculate JsonView Annotation
 					methodAttributes.setJsonViewAnnotation(AnnotatedElementUtils.findMergedAnnotation(method, JsonView.class));
+					//use the javadoc return if present
+					if (operationService.getJavadocProvider() != null) {
+						JavadocProvider javadocProvider = operationService.getJavadocProvider();
+						methodAttributes.setJavadocReturn(javadocProvider.getMethodJavadocReturn(methodParameter.getMethod()));
+					}
 					Map<String, ApiResponse> apiResponses = computeResponseFromDoc(components, methodParameter, apiResponsesOp, methodAttributes);
 					buildGenericApiResponses(components, methodParameter, apiResponsesOp, methodAttributes);
 					apiResponses.forEach(controllerAdviceInfoApiResponseMap::put);
@@ -456,7 +461,11 @@ private void buildApiResponses(Components components, MethodParameter methodPara
 			else if (CollectionUtils.isEmpty(apiResponse.getContent()))
 				apiResponse.setContent(null);
 			if (StringUtils.isBlank(apiResponse.getDescription())) {
-				setDescription(httpCode, apiResponse);
+				// use javadoc
+				if (!StringUtils.isBlank(methodAttributes.getJavadocReturn()))
+					apiResponse.setDescription(methodAttributes.getJavadocReturn());
+				else
+					setDescription(httpCode, apiResponse);
 			}
 		}
 		if (apiResponse.getContent() != null
@@ -551,7 +560,7 @@ private Map<String, ApiResponse> getGenericMapResponse(Class<?> beanType) {
 	private boolean isValidHttpCode(String httpCode, MethodParameter methodParameter) {
 		boolean result = false;
 		final Method method = methodParameter.getMethod();
-		if(method!=null){
+		if (method != null) {
 			Set<io.swagger.v3.oas.annotations.responses.ApiResponse> responseSet = getApiResponses(method);
 			if (isHttpCodePresent(httpCode, responseSet))
 				result = true;

springdoc-openapi-common/src/main/java/org/springdoc/core/JavadocProvider.java

@@ -0,0 +1,59 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package org.springdoc.core;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+
+/**
+ * The interface Javadoc provider.
+ * @author bnasslashen
+ */
+public interface JavadocProvider {
+
+	/**
+	 * Gets method description.
+	 *
+	 * @param method the method
+	 * @return the method description
+	 */
+	String getMethodJavadocDescription(Method method);
+
+	/**
+	 * Gets method javadoc return.
+	 *
+	 * @param method the method
+	 * @return the method javadoc return
+	 */
+	String getMethodJavadocReturn(Method method);
+
+	/**
+	 * Gets param javadoc.
+	 *
+	 * @param method the method
+	 * @param name the name
+	 * @return the param javadoc
+	 */
+	String getParamJavadoc(Method method, String name);
+
+	String getFieldJavadoc(Field field);
+}
+

springdoc-openapi-common/src/main/java/org/springdoc/core/MethodAttributes.java

@@ -107,6 +107,11 @@ public class MethodAttributes {
 	 */
 	private Map<String, ApiResponse> genericMapResponse = new LinkedHashMap<>();
 
+	/**
+	 * The javadoc Return.
+	 */
+	private String javadocReturn;
+
 	/**
 	 * Instantiates a new Method attributes.
 	 *
@@ -420,4 +425,22 @@ public void calculateHeadersForClass(Class<?> declaringClass) {
 			fillMethods(reqMappingClass.produces(), reqMappingClass.consumes(), reqMappingClass.headers());
 		}
 	}
+
+	/**
+	 * Gets javadoc return value
+	 *
+	 * @return the javadoc return
+	 */
+	public String getJavadocReturn() {
+		return javadocReturn;
+	}
+
+	/**
+	 * Sets javadoc return value.
+	 *
+	 * @param javadocReturn the javadoc return value
+	 */
+	public void setJavadocReturn(String javadocReturn) {
+		this.javadocReturn = javadocReturn;
+	}
 }

springdoc-openapi-common/src/main/java/org/springdoc/core/OperationService.java

@@ -86,21 +86,27 @@ public class OperationService {
 	 */
 	private final PropertyResolverUtils propertyResolverUtils;
 
+	/**
+	 * The javadoc provider.
+	 */
+	private final Optional<JavadocProvider> javadocProvider;
+
 	/**
 	 * Instantiates a new Operation builder.
-	 *
 	 * @param parameterBuilder the parameter builder
 	 * @param requestBodyService the request body builder
 	 * @param securityParser the security parser
 	 * @param propertyResolverUtils the property resolver utils
+	 * @param javadocProvider the javadoc provider
 	 */
 	public OperationService(GenericParameterService parameterBuilder, RequestBodyService requestBodyService,
-			SecurityService securityParser, PropertyResolverUtils propertyResolverUtils) {
+			SecurityService securityParser, PropertyResolverUtils propertyResolverUtils, Optional<JavadocProvider> javadocProvider) {
 		super();
 		this.parameterBuilder = parameterBuilder;
 		this.requestBodyService = requestBodyService;
 		this.securityParser = securityParser;
 		this.propertyResolverUtils = propertyResolverUtils;
+		this.javadocProvider = javadocProvider;
 	}
 
 	/**
@@ -389,7 +395,7 @@ private Optional<ApiResponses> getApiResponses(
 				setRef(apiResponsesObject, response, apiResponseObject);
 				continue;
 			}
-			setDescription(response, apiResponseObject);
+			setDescription(response, apiResponseObject, methodAttributes.getJavadocReturn());
 			setExtensions(response, apiResponseObject);
 
 			buildResponseContent(methodAttributes, components, classProduces, methodProduces, apiResponsesOp, response, apiResponseObject);
@@ -460,13 +466,17 @@ private void setLinks(io.swagger.v3.oas.annotations.responses.ApiResponse respon
 	 * Sets description.
 	 *
 	 * @param response the response
+	 * @param response the javadocReturn
 	 * @param apiResponseObject the api response object
 	 */
 	private void setDescription(io.swagger.v3.oas.annotations.responses.ApiResponse response,
-			ApiResponse apiResponseObject) {
+			ApiResponse apiResponseObject, String javadocReturn) {
 		if (StringUtils.isNotBlank(response.description())) {
 			apiResponseObject.setDescription(response.description());
 		}
+		else if (StringUtils.isNotBlank(javadocReturn)) {
+			apiResponseObject.setDescription(javadocReturn);
+		}
 		else {
 			GenericResponseService.setDescription(response.responseCode(), apiResponseObject);
 		}
@@ -608,4 +618,13 @@ public Operation mergeOperation(Operation operation, Operation operationModel) {
 		}
 		return operation;
 	}
+
+	/**
+	 * Gets javadoc provider.
+	 *
+	 * @return the javadoc provider
+	 */
+	public JavadocProvider getJavadocProvider() {
+		return javadocProvider.orElse(null);
+	}
 }

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java

@@ -138,18 +138,6 @@ else if (!componentSchemas.containsKey(entry.getKey())) {
 		return schemaN;
 	}
 
-	/**
-	 * Extract schema schema.
-	 *
-	 * @param components the components
-	 * @param genericParameterType the generic parameter type
-	 * @param jsonView the json view
-	 * @return the schema
-	 */
-	public static Schema extractSchema(Components components, Type genericParameterType, JsonView jsonView) {
-		return extractSchema(components, genericParameterType, jsonView, null);
-	}
-
 	/**
 	 * Gets content.
 	 *

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

@@ -212,21 +212,22 @@ ModelConverterRegistrar modelConverterRegistrar(Optional<List<ModelConverter>> m
 	}
 
 	/**
-	 * Operation builder operation builder.
+	 * Operation builder operation service.
 	 *
 	 * @param parameterBuilder the parameter builder
-	 * @param requestBodyService the request body builder
+	 * @param requestBodyService the request body service
 	 * @param securityParser the security parser
 	 * @param propertyResolverUtils the property resolver utils
-	 * @return the operation builder
+	 * @param javadocProvider the javadoc provider
+	 * @return the operation service
 	 */
 	@Bean
 	@ConditionalOnWebApplication
 	@ConditionalOnMissingBean
 	OperationService operationBuilder(GenericParameterService parameterBuilder, RequestBodyService requestBodyService,
-			SecurityService securityParser, PropertyResolverUtils propertyResolverUtils) {
+			SecurityService securityParser, PropertyResolverUtils propertyResolverUtils, Optional<JavadocProvider> javadocProvider) {
 		return new OperationService(parameterBuilder, requestBodyService,
-				securityParser, propertyResolverUtils);
+				securityParser, propertyResolverUtils, javadocProvider);
 	}
 
 	/**