Merge pull request #3 from SPIRIT-21/develop

Develop

README.md

@@ -78,6 +78,17 @@ For defining a resource, a path must be provided. When using a path parameter, i
  */
 public class ...
 ```
+
+When using multiple path parameters, please ensure that the `@format` tag is always given. If you don't want to specify a format, leave the text behind the tag empty. Example:
+
+```java
+/**
+ * @path /type/{id}/{childId}
+ * @pathParam id @type string @format
+ * @pathParam childId @type number @format long
+ */
+public class ...
+```
 
 ### Operations
 An operation must be defined in the same file as its resource! Otherwise the operation will be ignored because it cannot be assigned to a resource.
@@ -134,3 +145,4 @@ Following section lists some errors that might occure when executing the plugin
 	</dependencies>
 </plugin>
 ```
+If the error persists, you can ignore the whole Java file by placing the following somewhere in the Javadoc comments: `@swagger:ignore_javafile`. This doesn't fix the problem but allows you to still create Swagger for all your other Java files.

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.spirit21</groupId>
 	<artifactId>javadoc2swagger-maven-plugin</artifactId>
-	<version>1.1</version>
+	<version>1.2</version>
 	<packaging>maven-plugin</packaging>
 
 	<name>com.spirit21:javadoc2swagger-maven-plugin</name>
@@ -103,7 +103,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-gpg-plugin</artifactId>
-				<version>1.5</version>
+				<version>1.6</version>
 				<executions>
 					<execution>
 						<id>sign-artifacts</id>

src/main/java/com/spirit21/swagger/converter/loader/MethodLoader.java

@@ -46,6 +46,13 @@ public List<Method> getMethodsFromJavaFile(String file) {
         return methods;
     }
 
+    /**
+     * Finds HTTP methods in the annotation list
+     *
+     * @param annotations
+     *            Annotations as string
+     * @return formatted annotation or null
+     */
     private String findHttpMethodInAnnotations(List<String> annotations) {
         for (String annotation : annotations) {
             switch (annotation) {

src/main/java/com/spirit21/swagger/converter/parsers/DefinitionParser.java

@@ -99,9 +99,9 @@ public String createDefinitionIfNotExists(String input, List<String> imports, St
      */
     public Definition createDefinitionByClassName(String className, List<String> imports, String fileName,
             Definition rootDefinition, String filePackageName) throws ParserException {
-        log.info("new import sequence");
+        log.debug("new import sequence");
         for (String imp : imports) {
-            log.info("import: " + imp);
+            log.debug("import: " + imp);
             String regex = ".*[.]" + className;
             if (imp.matches(regex)) {
                 String classWithPackage = imp;