Skip to content

Commit

Permalink
Merge pull request #7 from Fork-World/6-endpoint-docs
Browse files Browse the repository at this point in the history
#6 - add enunciate to generate rest api docs
  • Loading branch information
svenruppert authored Apr 24, 2019
2 parents f85129f + 2c4724f commit 8662607
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ Module rest-backend - src/test/demo -> EndpointRunner
Module vaadin-ui - src/main/java -> BasicTestUIRunner

The REST Endpoint will run on localhost:8080

The API-Docs for the rest endpoint are on http://localhost:8080/apidocs/

The Swagger-UI will be on http://localhost:8080/apidocs/ui/index.html

The Vaadin UI will run on localhost:9999


20 changes: 20 additions & 0 deletions rest-backend/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,24 @@

</dependencies>

<build>
<plugins>
<plugin>
<groupId>com.webcohesion.enunciate</groupId>
<artifactId>enunciate-maven-plugin</artifactId>
<version>2.11.1</version>
<executions>
<execution>
<goals>
<goal>docs</goal>
</goals>
<configuration>
<!-- the directory where to put the docs -->
<docsDir>${project.build.directory}/classes/WEB</docsDir>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Microprofile server properties
server.port=8080
server.host=0.0.0.0
server.host=0.0.0.0
server.static.classpath.location=/WEB
server.static.classpath.welcome=index.html

0 comments on commit 8662607

Please sign in to comment.