Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pcalouche committed Aug 8, 2024
1 parent 6a7b6b9 commit 53cb4e0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
## Spring Skeleton
## Spring Forge Service Template

Spring Skeleton is a sample project to showcase the [Spring Forge Library](https://github.com/pcalouche/spring-forge) that uses Spring
Spring Forge Service Template is a sample project to showcase the [Spring Forge Library](https://github.com/pcalouche/spring-forge) that uses Spring
Auto-configuration to help with the configuration of some things.

Spring Forge provides a status endpoint, standard controller advice exception handling, and Open Api documentation configured. Running this application and
going to [localhost:8080/swagger-ui.html](localhost:8080/swagger-ui.html) will display the Open Api documentation. From there you'll see two endpoints:

1. /status - Demonstrates the status endpoint that is auto-configured by Spring Forge.
2. /exception-test - Demonstrates and endpoint that will throw and exception. The JSON response returned is derived from the code in Spring Forge.

It demonstrates using the logging and controller advice configuration of Spring Forge.
5 changes: 3 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
</parent>

<groupId>dev.pcalouche</groupId>
<artifactId>spring-forge-skeleton</artifactId>
<artifactId>spring-forge-service-template</artifactId>
<version>1.0.0-SNAPSHOT</version>
<description>Skeleton Spring Boot Project that uses Spring Forge</description>
<description>Spring Forge Service Template is a Spring Boot application that demonstrates how to use Spring Forge</description>
<url>https://github.com/pcalouche/spring-forge-service-template</url>

<distributionManagement>
<repository>
Expand Down

0 comments on commit 53cb4e0

Please sign in to comment.