Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To include swagger4spring-web in your project, you need to include the jar in yo
<dependency>
<groupId>com.knappsack</groupId>
<artifactId>swagger4spring-web</artifactId>
<version>0.3.3</version>
<version>0.3.1</version>
</dependency>


Expand All @@ -35,15 +35,15 @@ servlet context. For example:

If you are using version 0.3.0 or above, you'll also need to add the following to the appropriate Spring context file in your application:

<mvc:annotation-driven>
<mvc:message-converters>
<annotation-driven>
<message-converters>
<beans:bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<beans:property name="objectMapper">
<beans:bean class="com.knappsack.swagger4springweb.util.ScalaObjectMapper"/>
</beans:property>
</beans:bean>
</mvc:message-converters>
</mvc:annotation-driven>
</message-converters>
</annotation-driven>

Once the ApiDocumentationController is wired, you may call go to your base path + /api/resourceList (ex: http://localhost/swagger4spring-web-example/api/resourceList) in order to retrieve an inventory of your APIs. For an example JSP see this [page](https://github.com/wkennedy/swagger4spring-web-example/blob/master/src/main/webapp/WEB-INF/views/documentation.jsp).

Expand Down Expand Up @@ -75,7 +75,6 @@ To see a working example, please take a look at [swagger4spring-web-example](htt
The following Spring-Web annotations are supported:

* @Controller
* @RestController
* @RequestMapping
* @ResponseBody
* @RequestBody
Expand Down
74 changes: 42 additions & 32 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<parent>
<groupId>org.sonatype.oss</groupId>
<artifactId>oss-parent</artifactId>
<version>9</version>
<version>7</version>
</parent>

<name>swagger4spring-web</name>
<groupId>com.knappsack</groupId>
<artifactId>swagger4spring-web</artifactId>
<packaging>jar</packaging>
<version>0.3.5</version>
<version>0.3.16-SNAPSHOT-ALERTME</version>
<description>Swagger implementation for the Spring-Web framework</description>
<url>https://github.com/wkennedy/swagger4spring-web</url>
<licenses>
Expand All @@ -36,23 +36,21 @@
</developers>

<properties>
<org.springframework-version>4.0.6.RELEASE</org.springframework-version>
<org.wordnik-swagger-version>1.3.7</org.wordnik-swagger-version>
<org.springframework-version>3.2.5.RELEASE</org.springframework-version>
<org.wordnik-swagger-version>1.3.1</org.wordnik-swagger-version>
<org.slf4j-version>1.6.4</org.slf4j-version>
<org.logback-version>1.0.1</org.logback-version>
<junit-version>4.9</junit-version>
<java.version>1.8</java.version>
<jackson-module-scala_2.10.version>2.4.1</jackson-module-scala_2.10.version>
<org.reflections.version>0.9.9-RC2</org.reflections.version>
<servlet-api-version>3.1.0</servlet-api-version>
<paranamer-version>2.6.1</paranamer-version>
<java.version>1.6</java.version>
<jackson-module-scala_2.10.version>2.3.0</jackson-module-scala_2.10.version>
<org.reflections.version>0.9.10</org.reflections.version>
</properties>

<dependencies>
<dependency>
<groupId>org.scala-lang</groupId>
<artifactId>scala-library</artifactId>
<version>2.10.4</version>
<version>2.10.3</version>
</dependency>

<dependency>
Expand Down Expand Up @@ -92,58 +90,71 @@
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-annotations_2.10</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-core_2.10</artifactId>
<version>${org.wordnik-swagger-version}</version>
<exclusions>
<exclusion>
<artifactId>jackson-databind</artifactId>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>guava</artifactId>
<groupId>com.google.guava</groupId>
</exclusion>
<exclusion>
<artifactId>jackson-core</artifactId>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>paranamer</artifactId>
<groupId>com.thoughtworks.paranamer</groupId>
</exclusion>
<exclusion>
<artifactId>jackson-annotations</artifactId>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>slf4j-api</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
<exclusion>
<artifactId>scala-library</artifactId>
<groupId>org.scala-lang</groupId>
</exclusion>
<exclusion>
<artifactId>paranamer</artifactId>
<groupId>com.thoughtworks.paranamer</groupId>
<artifactId>jackson-databind</artifactId>
<groupId>com.fasterxml.jackson.core</groupId>
</exclusion>
<exclusion>
<artifactId>scala-reflect</artifactId>
<groupId>org.scala-lang</groupId>
<artifactId>jackson-core</artifactId>
<groupId>com.fasterxml.jackson.core</groupId>
</exclusion>
<exclusion>
<artifactId>slf4j-api</artifactId>
<groupId>org.slf4j</groupId>
<artifactId>jackson-annotations</artifactId>
<groupId>com.fasterxml.jackson.core</groupId>
</exclusion>
<exclusion>
<artifactId>jackson-module-scala_2.10</artifactId>
<groupId>com.fasterxml.jackson.module</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
<version>${org.reflections.version}</version>
<exclusions>
<exclusion>
<artifactId>guava</artifactId>
<groupId>com.google.guava</groupId>
</exclusion>
</exclusions>
</dependency>

<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>${servlet-api-version}</version>
<scope>provided</scope>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency>

<dependency>
<groupId>com.thoughtworks.paranamer</groupId>
<artifactId>paranamer</artifactId>
<version>${paranamer-version}</version>
<version>2.6</version>
</dependency>

<!--logging-->
Expand Down Expand Up @@ -202,7 +213,7 @@
<plugin>
<groupId>net.alchim31.maven</groupId>
<artifactId>scala-maven-plugin</artifactId>
<version>3.1.6</version>
<version>3.1.5</version>
<configuration>
<checkMultipleScalaVersions>false</checkMultipleScalaVersions>
</configuration>
Expand All @@ -227,11 +238,10 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<version>2.5.1</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<compilerArgument>-parameters</compilerArgument>
</configuration>
<executions>
<execution>
Expand All @@ -245,7 +255,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.3</version>
<version>2.1.2</version>
<executions>
<execution>
<id>attach-sources</id>
Expand All @@ -258,7 +268,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<version>2.9</version>
<executions>
<execution>
<id>attach-javadocs</id>
Expand Down
Loading