Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 3.61 KB

GETTING-STARTED.md

File metadata and controls

92 lines (62 loc) · 3.61 KB
Raw

Start Here

In the next sections, we'll look at the design (or specification) of each of the components needed for a given requirement.

Generally speaking, each functionality will be implemented via four types of components:

  1. A controller

    It will be in charge of handling a HTTP request, and responding with an appropriate JSON over HTTP response.

  2. A query or a command

    Following the Command and Query Responsibility Segregation pattern. A command is used to change the state of the system, whereas a query is used to retrieve information about the system.

  3. A domain entity

    Which we'll use to model a recipe and its operations.

  4. A repository

    Which we'll use to store and retrieve recipes in the system. For simplicity, we'll use an in-memory repository.

Run the application locally

This application is a simple server (for the web API) built using the Spring Boot framework.

First, ensure that you have Java installed by running the following in your terminal:

$ javac -version

javac 17.0.4

Or:

$ java -version

openjdk version "17.0.4" 2022-07-19 LTS
OpenJDK Runtime Environment Zulu17.36+13-CA (build 17.0.4+8-LTS)
OpenJDK 64-Bit Server VM Zulu17.36+13-CA (build 17.0.4+8-LTS, mixed mode, sharing)

Start the server

To start the server, run the following command:

cd api
./mvnw spring-boot:run

You should be able to see a similar output to this:

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.7.4)

2022-10-01 19:32:15.252  INFO 7013 --- [           main] c.c.recipe.RecipeApiApplication          : Starting RecipeApiApplication using Java 17.0.4 
2022-10-01 19:32:15.254  INFO 7013 --- [           main] c.c.recipe.RecipeApiApplication          : No active profile set, falling back to 1 default profile: "default"
2022-10-01 19:32:15.914  INFO 7013 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2022-10-01 19:32:15.922  INFO 7013 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2022-10-01 19:32:15.922  INFO 7013 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.65]
2022-10-01 19:32:15.996  INFO 7013 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2022-10-01 19:32:15.996  INFO 7013 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 706 ms
2022-10-01 19:32:16.490  INFO 7013 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2022-10-01 19:32:16.498  INFO 7013 --- [           main] c.c.recipe.RecipeApiApplication          : Started RecipeApiApplication in 1.7 seconds (JVM running for 1.944)

A GET request to localhost:8080/greeting (via Postman, or your browser for example) should return a 200 OK response with:

Hello World!

Open API Documentation

Once the server is started, navigating to http://localhost:8080/swagger-ui/index.html should display a documentation page for your API.


Opean API documentation