fixes #15

automatically enhance StatusCodes

Author: hoegertn

src/main/java/org/restdoc/server/impl/RestDocGenerator.java

@@ -37,6 +37,7 @@
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.Response.Status;
 
 import org.restdoc.annotations.RestDocAccept;
 import org.restdoc.annotations.RestDocHeader;
@@ -239,17 +240,19 @@ private void addResourceMethod(final String basepath, final Method method) {
 			this.ext.newResource(restResource);
 		}
 
-		if (restResource.getMethods().containsKey(methodType)) {
-			this.logger.warn("Duplicate method detected for resource: " + path + " -> " + methodType);
-			return;
+		final MethodDefinition def;
+		if (!restResource.getMethods().containsKey(methodType)) {
+			def = new MethodDefinition();
+			def.setDescription(methodDescription);
+			def.setResponse(new ResponseDefinition());
+		} else {
+			def = restResource.getMethods().get(methodType);
 		}
 
-		final MethodDefinition def = new MethodDefinition();
-		def.setDescription(methodDescription);
 		def.getHeaders().putAll(methodRequestHeader);
 		def.getAccepts().addAll(this.getAccepts(method, parameterTypes, parameterAnnotations));
 		def.getStatusCodes().putAll(this.getStatusCodes(method));
-		def.setResponse(this.getMethodResponse(method));
+		this.addMethodResponse(def.getResponse(), method);
 
 		restResource.getMethods().put(methodType, def);
 
@@ -329,17 +332,19 @@ protected void parseMethodParameter(final List<String> queryParams, final Map<St
 		}
 	}
 
-	private ResponseDefinition getMethodResponse(final Method method) {
-		final ResponseDefinition def = new ResponseDefinition();
+	private void addMethodResponse(final ResponseDefinition def, final Method method) {
+		boolean typeFound = false;
 		if (method.isAnnotationPresent(RestDocResponse.class)) {
 			final RestDocResponse docResponse = method.getAnnotation(RestDocResponse.class);
 			final RestDocType[] types = docResponse.types();
 			for (final RestDocType restDocType : types) {
 				if (!restDocType.schemaClass().equals(Object.class)) {
 					final String schema = SchemaResolver.getSchemaFromType(restDocType.schemaClass(), this.schemaMap, this.ext);
 					def.type(restDocType.type(), schema);
+					typeFound = true;
 				} else {
 					def.type(restDocType.type(), restDocType.schema());
+					typeFound = true;
 				}
 			}
 
@@ -348,7 +353,7 @@ private ResponseDefinition getMethodResponse(final Method method) {
 				def.header(restDocHeader.name(), restDocHeader.description(), restDocHeader.required());
 			}
 		}
-		if (def.getTypes().isEmpty() && !method.getReturnType().equals(Void.TYPE)) {
+		if (!typeFound && !method.getReturnType().equals(Void.TYPE)) {
 			final String schema = SchemaResolver.getSchemaFromTypeOrNull(method.getGenericReturnType(), this.schemaMap, this.ext);
 			String[] mediaTypes = MediaTypeResolver.getProducesMediaType(method);
 			if (mediaTypes != null) {
@@ -357,17 +362,23 @@ private ResponseDefinition getMethodResponse(final Method method) {
 				}
 			}
 		}
-		return def;
 	}
 
 	private Map<String, String> getStatusCodes(final Method method) {
 		final Map<String, String> codeMap = Maps.newHashMap();
 		if (method.isAnnotationPresent(RestDocReturnCodes.class)) {
 			final RestDocReturnCode[] returnCodes = method.getAnnotation(RestDocReturnCodes.class).value();
 			for (final RestDocReturnCode rdrc : returnCodes) {
-				codeMap.put(rdrc.code(), rdrc.description());
+				String description = rdrc.description();
+				if (description.isEmpty()) {
+					description = Status.fromStatusCode(Integer.valueOf(rdrc.code())).getReasonPhrase();
+				}
+				codeMap.put(rdrc.code(), description);
 			}
 		}
+		if (method.getReturnType().equals(Void.TYPE)) {
+			codeMap.put(String.valueOf(Status.NO_CONTENT.getStatusCode()), Status.NO_CONTENT.getReasonPhrase());
+		}
 		return codeMap;
 	}
 

src/test/java/org/restdoc/server/impl/MyRSBean.java

@@ -19,6 +19,7 @@
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.POST;
+import javax.ws.rs.PUT;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
@@ -96,29 +97,42 @@ public List<Msg> getMessageListJson() {
 	@RestDoc(id = "message", resourceDescription = "A single message", methodDescription = "Read the message content")
 	@RestDocReturnCodes({@RestDocReturnCode(code = "200", description = "All went well"), @RestDocReturnCode(code = "403", description = "Access not allowed"), @RestDocReturnCode(code = "404", description = "Message not found")})
 	@Produces("text/plain")
-	@Consumes("text/plain")
 	public String getMessage(@PathParam("id") @RestDocParam(description = "The message id") final String id) {
 		if (this.messages.containsKey(id)) {
 			return this.messages.get(id);
 		}
 		throw new WebApplicationException(Status.NOT_FOUND);
 	}
 
+	/**
+	 * @param id
+	 * @return the message
+	 */
+	@Path("/{id}")
+	@GET
+	@RestDoc(id = "message", resourceDescription = "A single message", methodDescription = "Read the message content")
+	@RestDocReturnCodes({@RestDocReturnCode(code = "200", description = "All went well"), @RestDocReturnCode(code = "403", description = "Access not allowed"), @RestDocReturnCode(code = "404", description = "Message not found")})
+	@Produces("application/json")
+	public String getMessageJSON(@PathParam("id") @RestDocParam(description = "The message id") final String id) {
+		if (this.messages.containsKey(id)) {
+			return this.messages.get(id);
+		}
+		throw new WebApplicationException(Status.NOT_FOUND);
+	}
+	
 	/**
 	 * @param id
 	 * @param content
 	 * @return the created message
 	 */
 	@Path("/{id}")
-	@POST
+	@PUT
 	@RestDoc(methodDescription = "Update the message content")
-	@RestDocReturnCodes({@RestDocReturnCode(code = "200", description = "All went well"), @RestDocReturnCode(code = "403", description = "Access not allowed")})
-	@Produces("text/plain")
+	@RestDocReturnCodes({@RestDocReturnCode(code = "403", description = "")})
 	@Consumes("text/plain")
 	@Scopes("write")
-	public String setMessage(@PathParam("id") final String id, final String content) {
+	public void setMessage(@PathParam("id") final String id, final String content) {
 		this.messages.put(id, content);
-		return content;
 	}
 
 	/**
@@ -133,7 +147,8 @@ public String setMessage(@PathParam("id") final String id, final String content)
 	@Consumes("application/json")
 	@SuppressWarnings("unused")
 	public String setMessage(final Msg msg, @QueryParam("X-TTL") @RestDocParam(description = "The message lifetime") final Long lifetime) {
-		return this.setMessage(msg.getId(), msg.getContent());
+		this.setMessage(msg.getId(), msg.getContent());
+		return msg.getContent();
 	}
 
 }