The project code is already pushed to GitHub repository<\/a>. Open New Project window in IntelliJ by going to File -> New -> New Project , and choose Spring Initializr from the left side bar, then put your new project parameters like below image :<\/p>\n\n\n\n As you can see in the above image, I am going to develop this project on Java 8. Click on next button to navigate to dependencies selection step, there we choose the dependencies we want to use in our project. <\/p>\n\n\n\n In the list at the right bottom of the window you can see that I imported the Lombok<\/strong>, Spring Boot DevTools<\/strong>, Spring Web<\/strong>, Spring HATEOAS<\/strong>, Spring Data JPA<\/strong>, H2 Database<\/strong>, and MySQL Driver <\/strong>into the project dependencies. Let’s what is the purpose of each of imported library :<\/p>\n\n\n\n OpenAPI<\/strong> is an API description format to describe and visualize RESTful APIs . It allows developers to describe entire API including available endpoints and methods on each endpoints, operation’s parameters and their input-output format. Swagger<\/strong> is a set of tools built based on the OpenAPI specification that facilitate the process of designing, building, documenting and consuming REST APIs. Here we use springdoc-openapi-ui<\/strong> library to generate API documentation automatically at runtime. It also contains Swagger-ui in itself, so that our application’s endpoint can be easily accessed and understood within a single \/swagger-ui.html page . So we add this library to Maven dependency like below :<\/p>\n\n\n\n The NoteBook entity class : <\/p>\n\n\n\n In the NoteBookRepository interface, I added a custom findAll function that accepts Pageable to add pagination support to our webservice which we will code in next sections:<\/p>\n\n\n\n <\/p>\n\n\n\n The important note about the service class is the @AutoWired annotation which injects NotebookRepository bean into the service class. All other codes and methods are commented and explained well :<\/p>\n\n\n\n In the Controller class I Autowired EntityLinks from HATEOAS library to add self descriptive links to endpoints’ responses (Why? because being self descriptive, i.e. having link to guide client to fetch more details is one mandatory RESTful rules). To do that, we need to add @EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)<\/span><\/em><\/strong> annotation to the main application class . If you remember we extended the NoteBook entity class from RepresentationModel<\/span> in earlier section , we did it because it allows us to add HATEOAS related fields to the notebook records in output.<\/p>\n\n\n\n Moreover, as you can see in the code, we used springdoc-openapi<\/strong> annotations to describe each endpoint in OpenAPI format. Annotations are : <\/p>\n\n\n\n It is a common approach in unit tests and integration tests to work with H2 database instead of real database of production environment. We declare two application.properties<\/strong>, one in the main\/Resources<\/strong> and another one in the test\/Resources<\/strong>. In the application.properties<\/strong> file of main package we define the real database specifications and in the other one we define the H2 database specifications :<\/p>\n\n\n\n Main application.properties, configured to use MySQL database :<\/p>\n\n\n\n Test application.properties, configured to use H2 database : <\/p>\n\n\n\n Now that the database configuration is done, we want to preload a number of notebook records in the database on application startup. So, we add a configuration class with a CommandLineRunner<\/strong> bean to our project, the CommandLineRunner<\/strong> run just after application startup. But, we don’t need these preload data in the test time. How to prevent CommandLineRunner<\/strong> execution in unit test? There exist several way to prevent CommandLineRunner<\/strong> to be executed at startup. The easiest way that we can prevent it from running is by annotating the class with <\/em>@Profile<\/em>(“!test”)<\/strong> which means it will not be wired into contexts annotated with @ActiveProfiles(“test”)<\/em><\/strong>. <\/p>\n\n\n\n We use @SpringBootTest to import main application context automatically, and MockMVC<\/strong> is autowired to help us in simulating endpoints call. As we see, the test class is annotated with @ActiveProfiles(\u201ctest\u201d)<\/em><\/strong> to prevent CommandLineRunner<\/strong> to be executed, however the @ActiveProfiles(\u201ctest\u201d)<\/em><\/strong> functionality is not limited to this purpose. The test will automatically read JPA database configuration from test\/Resources\/application.properties<\/strong>, and we already set its parameters to work with H2 database. @Sql <\/strong>annotation with executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD<\/em><\/strong> parameter reads the beforeTestRun.sql<\/strong> file and execute it before each test, the file is located in Resources folder. The beforeTestRun.sql<\/strong> file Contains script to create the table and insert initial test records. And the second @Sql<\/strong> with executionPhase = <\/strong> Sql.ExecutionPhase.AFTER_TEST_METHOD<\/strong> executes the given sql file after each test, the script within the beforeTestRun.sql contains script to drop the note_book table. For deleting the table after each test we could use @DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_EACH_TEST_METHOD<\/em>) <\/strong>annotation reset the database and revert any changes made by other tests before starting each test, But the big difference is that it restarts the application as well.<\/p>\n\n\n\n To Dockerize our project we need to build two docker container, one for our application and another for MySQL. We make the image from our application by DockerFile<\/strong>, and to build the MySQL container and integrate it to the container build from our application docker image we need to use docker-compose.yml<\/strong> file. We put both of these files into application root path. In the docker file we first clone a java8 image and copy our application source files to it, then after changing the chmod<\/strong> of mvnw<\/strong> file, we compile, test and build the output jar file with package<\/strong> command of maven, then we configure the container to run the jar file on startup with ENTRYPOINT<\/strong> command. The DockerFile :<\/p>\n\n\n\n In the docker-compose.yml <\/strong>file, we first clone the mysql image from dockerhub or local host and start it, then we make our application image by referencing to the DockerFile that already defined, but we wait until the mysql container to be started and fully operational before we create\/start our application container. we do that by depends_on<\/strong> and healthcheck<\/strong>.<\/p>\n\n\n\n Finally, execcute following command in the application root path to build your docker containers :<\/p>\n\n\n\n Thanks to SwaggerUI, you can see endpoints documentation in a graphical user interface and try out their functionality and see the response. After running the containers, you can access the application links with :<\/p>\n\n\n\n Happy coding!<\/p>\n","protected":false},"excerpt":{"rendered":" In this article, we will develop a sample Spring Boot application in IntelliJ IDEA 2021 using Maven. It exposes numbers of RESTful APIs compatible with Open … <\/p>\n","protected":false},"author":1,"featured_media":930,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,124,69,123,125,35,70,122],"tags":[115,120,117,9,64,114,113,118,119,63,71,112,121,116],"_links":{"self":[{"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/posts\/862"}],"collection":[{"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/comments?post=862"}],"version-history":[{"count":0,"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/posts\/862\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/media\/930"}],"wp:attachment":[{"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/media?parent=862"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/categories?post=862"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mshaeri.com\/blog\/wp-json\/wp\/v2\/tags?post=862"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
This tutorial consists of 7 main sections :<\/p>\n\n\n\nProject Creation<\/h3>\n\n\n\n
![\"\"](\"https:\/\/m-shaeri.ir\/blog\/wp-content\/uploads\/2022\/02\/image-4.png\")
<\/a>![\"\"](\"https:\/\/m-shaeri.ir\/blog\/wp-content\/uploads\/2022\/02\/image-5.png\")
<\/a> OpenAPI Related Dependencies<\/span><\/h2>\n\n\n\n
<dependencies>\n<!-- Other dependencies-->\n<dependency>\n <groupId>org.springdoc<\/groupId>\n <artifactId>springdoc-openapi-ui<\/artifactId>\n <version>1.6.4<\/version>\n <\/dependency>\n<\/dependencies><\/code><\/pre>\n\n\n\nEntity And Repository <\/h2>\n\n\n\n
package bdp.sample.notebookmanager.entities;\n\nimport org.hibernate.annotations.UpdateTimestamp;\nimport org.springframework.hateoas.RepresentationModel;\n\nimport javax.persistence.*;\nimport java.sql.Timestamp;\nimport java.util.Objects;\n\n@Entity\npublic class NoteBook extends RepresentationModel<NoteBook> {\n private Integer ID;\n private String name;\n private double currentPrice;\n private Timestamp lastUpdate;\n\n public NoteBook(){\n\n }\n\n public NoteBook(Integer ID, String name, double currentPrice){\n this.ID = ID;\n this.name = name;\n this.currentPrice = currentPrice;\n }\n public NoteBook(String name, double currentPrice){\n this.name = name;\n this.currentPrice = currentPrice;\n }\n\n @Id\n @Column(name = \"id\")\n @GeneratedValue(strategy = GenerationType.IDENTITY<\/em>) \/\/ id generate by the database native approach\n public Integer getID() {\n return ID;\n }\n\n public void setID(Integer ID) {\n this.ID = ID;\n }\n\n @Basic\n @Column(name = \"name\", unique = true)\n public String getName() {\n return name;\n }\n\n public void setName(String name) {\n this.name = name;\n }\n\n @Basic\n @Column(name = \"currentPrice\")\n public double getCurrentPrice() {\n return currentPrice;\n }\n\n public void setCurrentPrice(double currentPrice) {\n this.currentPrice = currentPrice;\n }\n\n @Basic\n @Column(name = \"lastUpdate\")\n @UpdateTimestamp\n\n public Timestamp getLastUpdate() {\n return lastUpdate;\n }\n\n public void setLastUpdate(Timestamp lastUpdate) {\n this.lastUpdate = lastUpdate;\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) return true;\n if (o == null || getClass() != o.getClass()) return false;\n NoteBook notebook = (NoteBook) o;\n return ID == notebook.ID && currentPrice == notebook.currentPrice && Objects.equals<\/em>(name, notebook.name) && Objects.equals<\/em>(lastUpdate, notebook.lastUpdate);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash<\/em>(ID, name, currentPrice, lastUpdate);\n }\n}\n<\/code><\/pre>\n\n\n\npackage bdp.sample.notebookmanager.repositories;\n\nimport org.springframework.data.domain.Page;\nimport org.springframework.data.domain.Pageable;\nimport org.springframework.data.jpa.repository.JpaRepository;\nimport org.springframework.stereotype.Repository;\nimport bdp.sample.notebookmanager.entities.NoteBook;\n\n@Repository\npublic interface NoteBookRepository extends JpaRepository<NoteBook,Integer> {\n\n public Page<NoteBook> findAll(Pageable page);\n}\n<\/code><\/pre>\n\n\n\nService And Controller<\/h2>\n\n\n\n
package bdp.sample.notebookmanager.services;\n\n\nimport bdp.sample.notebookmanager.repositories.NoteBookRepository;\nimport org.springframework.beans.factory.annotation.Autowired;\n\n\nimport org.springframework.data.domain.PageRequest;\nimport org.springframework.data.domain.Sort;\nimport org.springframework.stereotype.Service;\nimport bdp.sample.notebookmanager.entities.NoteBook;\n\nimport java.util.List;\nimport java.util.Optional;\n\n@Service\npublic class NoteBookService {\n\n @Autowired\n NoteBookRepository noteBookRepository;\n\n \/\/This method gets page index and page size and returns records from database accordingly\n public List<NoteBook> listnotebooks(int page, int size){\n return noteBookRepository.findAll(PageRequest.of<\/em>(page, size, Sort.by<\/em>(\"ID\").ascending())).toList();\n }\n\n \/\/ This method gets an Id and returns corresponding notebook if it exists, otherwise it returns null\n public NoteBook getnotebookById(int notebookId){\n Optional<NoteBook> notebook = noteBookRepository.findById(notebookId);\n if (notebook.isPresent())\n return notebook.get();\n \/\/ returns null if the given Id doesn't exist\n return null;\n }\n\n \/\/ This method creates given notebook object in the database and returns it with its Id\n public NoteBook createnotebook(NoteBook notebook){\n\n return noteBookRepository.save(notebook);\n }\n\n \/\/This method gets a notebook object along with its Id, updates the name and currentPrice and returns it back\n \/\/if the notebook Id doesn't exist, it returns null\n public NoteBook updatenotebook(int notebookId, NoteBook changednotebook){\n Optional<NoteBook> notebook = noteBookRepository.findById(notebookId);\n \/\/Check if the notebook exists\n if (notebook.isPresent()) {\n NoteBook tempnotebook= notebook.get();\n tempnotebook.setName(changednotebook.getName());\n tempnotebook.setCurrentPrice(changednotebook.getCurrentPrice());\n \/\/ Save and return updated notebook object\n return noteBookRepository.save(tempnotebook);\n }\n\n \/\/ returns null if the given Id doesn't exist\n return null;\n }\n\n \/\/This method gets a notebook Id and delete the corresponding notebook record in databse\n \/\/if the notebook Id doesn't exist, it returns null\n public boolean deletenotebook(int notebookId){\n Optional<NoteBook> notebook = noteBookRepository.findById(notebookId);\n \/\/Check if the notebook exists\n if (notebook.isPresent()) {\n noteBookRepository.delete(notebook.get());\n return true;\n }\n\n \/\/ returns null if the given Id doesn't exist\n return false;\n }\n\n}\n<\/code><\/pre>\n\n\n\npackage bdp.sample.notebookmanager.controller;\n\n\nimport io.swagger.v3.oas.annotations.Operation;\nimport io.swagger.v3.oas.annotations.Parameter;\nimport io.swagger.v3.oas.annotations.media.Content;\nimport io.swagger.v3.oas.annotations.media.Schema;\nimport io.swagger.v3.oas.annotations.responses.ApiResponse;\nimport io.swagger.v3.oas.annotations.responses.ApiResponses;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.dao.DataIntegrityViolationException;\nimport org.springframework.hateoas.*;\nimport org.springframework.hateoas.server.EntityLinks;\nimport org.springframework.hateoas.server.ExposesResourceFor;\nimport org.springframework.hateoas.server.mvc.WebMvcLinkBuilder;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\nimport org.springframework.web.bind.MissingServletRequestParameterException;\nimport org.springframework.web.bind.annotation.*;\nimport org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;\nimport bdp.sample.notebookmanager.entities.NoteBook;\nimport bdp.sample.notebookmanager.services.NoteBookService;\n\nimport java.security.InvalidParameterException;\nimport java.util.List;\n\n@RestController\n@ExposesResourceFor(NoteBook.class)\n@RequestMapping(\"\/api\/notebooks\")\npublic class NoteBookController {\n\n @Autowired\n private EntityLinks entityLinks;\n\n @Autowired\n private NoteBookService noteBookService;\n\n\n \/\/ GET \/api\/notebooks (get a list of notebooks)\n @Operation(summary = \"Get list of notebooks (Ordered by Id in ascending order), you must specify page number and page size\")\n @ApiResponses(value = {\n @ApiResponse(responseCode = \"200\", description = \"Successful Operation\",\n content = { @Content(mediaType = \"application\/json\") }),\n @ApiResponse(responseCode = \"400\", description = \"Invalid parameters supplied\",\n content = @Content),\n @ApiResponse(responseCode = \"500\", description = \"Internal Error\",\n content = @Content)})\n @GetMapping(produces = { \"application\/json\" })\n public ResponseEntity<CollectionModel<NoteBook>> getnotebooks(@Parameter(description = \"Page index (start from 0)\") @RequestParam(value = \"page\") Integer page, @Parameter(description = \"Number of records per page\") @RequestParam(value = \"pageSize\") Integer pageSize) {\n\n \/\/ Retrieve requested portion of notebooks from database\n List<NoteBook> notebookList = noteBookService.listnotebooks(page,pageSize);\n\n \/\/ Add self Link to each record as url for retrieving the record\n for (NoteBook notebook : notebookList) {\n Link recordSelfLink = WebMvcLinkBuilder.linkTo(WebMvcLinkBuilder.methodOn(NoteBookController.class)\n .getnotebookById(notebook.getID())).withSelfRel();\n notebook.add(recordSelfLink);\n }\n CollectionModel<NoteBook> resources = CollectionModel.of(notebookList);\n \/\/ selfLink to api according to HATEOS\n Link selfLink = entityLinks.linkToCollectionResource(NoteBook.class);\n resources.add(selfLink);\n\n \/\/ Send data to client as a response\n return new ResponseEntity(EntityModel.of(resources),HttpStatus.OK);\n }\n\n\n \/\/GET \/api\/notebooks\/1 (get one notebook from the list)\n @Operation(summary = \"Get a notebook by its id\")\n @ApiResponses(value = {\n @ApiResponse(responseCode = \"200\", description = \"Found the notebook\",\n content = { @Content(mediaType = \"application\/json\",\n schema = @Schema(implementation = NoteBook.class)) }),\n @ApiResponse(responseCode = \"400\", description = \"Invalid id supplied\",\n content = @Content),\n @ApiResponse(responseCode = \"404\", description = \"notebook not found\",\n content = @Content),\n @ApiResponse(responseCode = \"500\", description = \"Internal Error\",\n content = @Content) })\n @GetMapping(value = \"\/{notebookId}\", produces = { \"application\/json\" })\n public ResponseEntity<EntityModel<NoteBook>> getnotebookById(@Parameter(description = \"id of notebook to be retrieved\") @PathVariable int notebookId){\n\n \/\/ selfLink to api according to HATEOS\n Link selfLink = entityLinks.linkToItemResource(NoteBook.class, notebookId);\n \/\/ Retrieve requested notebook from database\n NoteBook notebook = noteBookService.getnotebookById(notebookId);\n \/\/Check whether the notebook exist or not\n if(notebook!=null) {\n EntityModel<NoteBook> resource = EntityModel.of(notebook);\n resource.add(selfLink);\n \/\/ Send data to client as a response\n return new ResponseEntity(EntityModel.of(resource),HttpStatus.OK);\n }\n\n \/\/ If no notebook is found send 404 status code as response\n return new ResponseEntity(null, HttpStatus.NOT_FOUND);\n }\n\n\n \/\/ POST \/api\/notebooks (create a notebook)\n @Operation(summary = \"Create a new notebook\")\n @ApiResponses(value = {\n @ApiResponse(responseCode = \"201\", description = \"notebook created\",\n content = { @Content(mediaType = \"application\/json\",\n schema = @Schema(implementation = NoteBook.class)) }),\n @ApiResponse(responseCode = \"400\", description = \"Invalid id supplied\",\n content = @Content),\n @ApiResponse(responseCode = \"404\", description = \"notebook not found\",\n content = @Content),\n @ApiResponse(responseCode = \"500\", description = \"Internal Error\",\n content = @Content),\n @ApiResponse(responseCode = \"409\", description = \"Duplicate notebook name\",\n content = @Content) })\n @PostMapping\n public ResponseEntity<EntityModel<NoteBook>> createnotebook(@RequestBody NoteBook notebook){\n\n \/\/ Create and Save notebook in database\n NoteBook storednotebook = noteBookService.createnotebook(notebook);\n\n \/\/ Check whether the notebook is saved or not\n if(notebook!=null) {\n \/\/ selfLink to api that retrieves the notebook according to HATEOS\n Link recordSelfLink = WebMvcLinkBuilder.linkTo(WebMvcLinkBuilder.methodOn(NoteBookController.class)\n .getnotebookById(notebook.getID())).withSelfRel();\n notebook.add(recordSelfLink);\n \/\/ Send created notebook with 201 status code to client\n return new ResponseEntity(EntityModel.of(storednotebook), HttpStatus.CREATED);\n }\n \/\/ If no notebook is saved send 304 status code\n return new ResponseEntity(null, HttpStatus.NOT_MODIFIED);\n }\n\n\n \/\/PATCH \/api\/notebooks\/1 (update the price of a single notebook)\n @Operation(summary = \"Update a notebook by its id\")\n @ApiResponses(value = {\n @ApiResponse(responseCode = \"202\", description = \"notebook updated\",\n content = { @Content(mediaType = \"application\/json\",\n schema = @Schema(implementation = NoteBook.class)) }),\n @ApiResponse(responseCode = \"400\", description = \"Invalid id supplied\",\n content = @Content),\n @ApiResponse(responseCode = \"404\", description = \"notebook not found\",\n content = @Content),\n @ApiResponse(responseCode = \"500\", description = \"Internal Error\",\n content = @Content),\n @ApiResponse(responseCode = \"409\", description = \"Duplicate notebook name\",\n content = @Content) })\n @PatchMapping(value = \"\/{notebookId}\", produces = { \"application\/json\" })\n public ResponseEntity<EntityModel<NoteBook>> updatenotebook(@Parameter(description = \"id of notebook to be updated\") @PathVariable int notebookId, @Parameter(description = \"notebook updated information\") @RequestBody NoteBook notebook){\n\n \/\/ Update notebook in the database\n NoteBook storednotebook = noteBookService.updatenotebook(notebookId,notebook);\n\n \/\/ Check whether the notebook exist and is updated or not\n if(storednotebook!=null) {\n \/\/ selfLink to api that retrieves the notebook according to HATEOS\n Link recordSelfLink = WebMvcLinkBuilder.linkTo(WebMvcLinkBuilder.methodOn(NoteBookController.class)\n .getnotebookById(notebook.getID())).withSelfRel();\n notebook.add(recordSelfLink);\n \/\/ Send updated notebook with 202 status code to client\n return new ResponseEntity(EntityModel.of(storednotebook), HttpStatus.ACCEPTED);\n }\n\n \/\/ If no notebook is found send 404 status code as response\n return new ResponseEntity(null, HttpStatus.NOT_FOUND);\n }\n\n \/\/ DELETE\/api\/notebooks\/1 (delete a single notebook)\n @Operation(summary = \"Delete a notebook by its id\")\n @ApiResponses(value = {\n @ApiResponse(responseCode = \"202\", description = \"notebook deleted\",\n content = @Content),\n @ApiResponse(responseCode = \"400\", description = \"Invalid id supplied\",\n content = @Content),\n @ApiResponse(responseCode = \"404\", description = \"notebook not found\",\n content = @Content),\n @ApiResponse(responseCode = \"500\", description = \"Internal Error\",\n content = @Content) })\n @DeleteMapping(value = \"\/{notebookId}\")\n public ResponseEntity<EntityModel<NoteBook>> deletenotebook(@Parameter(description = \"id of notebook to be deleted\") @PathVariable int notebookId){\n\n \/\/ Delete the notebook by its Id and check for the result\n if(noteBookService.deletenotebook(notebookId))\n \/\/ Sent empty response with 202 status code\n return new ResponseEntity(null, HttpStatus.ACCEPTED);\n else\n \/\/ If no notebook is found send 404 status code as response\n return new ResponseEntity(null, HttpStatus.NOT_FOUND);\n }\n\n\n\n\n \/\/ Handling exceptions related to user input\n @ExceptionHandler({ MissingServletRequestParameterException.class, InvalidParameterException.class, MethodArgumentTypeMismatchException.class })\n public ResponseEntity<String> handleUserInputException() {\n\n return new ResponseEntity(\"Bad Request\", HttpStatus.BAD_REQUEST);\n }\n\n \/\/ Handling runtime exception\n @ExceptionHandler({ RuntimeException.class })\n public ResponseEntity<String> handleRuntimeException() {\n\n return new ResponseEntity(null, HttpStatus.INTERNAL_SERVER_ERROR);\n }\n\n\n\n @ExceptionHandler({ DataIntegrityViolationException.class })\n public ResponseEntity<String> handleDuplicateException() {\n\n return new ResponseEntity(null, HttpStatus.CONFLICT);\n }\n}\n\n<\/code><\/pre>\n\n\n\n JPA configuration and preload data<\/h2>\n\n\n\n
spring.jpa.hibernate.ddl-auto=update\njdbc.driverClassName=com.mysql.cj.jdbc.Driver\nspring.datasource.url=jdbc:mysql:\/\/localhost:3306\/notebook_manager?useSSL=false\nspring.jpa.database-platform = org.hibernate.dialect.MySQL5InnoDBDialect\nspring.datasource.username=root\nspring.datasource.password=<\/code><\/pre>\n\n\n\njdbc.driverClassName=org.h2.Driver\nspring.datasource.url=jdbc:h2:mem:myDb;DB_CLOSE_DELAY=-1\nspring.jpa.database-platform=org.hibernate.dialect.H2Dialect\nspring.jpa.hibernate.ddl-auto=create<\/code><\/pre>\n\n\n\npackage bdp.sample.notebookmanager.configs;\n\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\nimport org.springframework.boot.CommandLineRunner;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport bdp.sample.notebookmanager.entities.NoteBook;\nimport bdp.sample.notebookmanager.repositories.NoteBookRepository;\nimport org.springframework.context.annotation.Profile;\n\n\n@Configuration\n@Profile(\"!test\")\nclass InitiateDatabaseRecords {\n\n private static final Logger log <\/em>= LoggerFactory.getLogger<\/em>(InitiateDatabaseRecords.class);\n\n\n @Bean\n CommandLineRunner initDatabase(NoteBookRepository repository) {\n if(repository.findAll().size()<1) {\n return args -> {\n try {\n \/\/ insert initial records into DB\n repository.save(new NoteBook(\"Asus Vivo Book S\", 211.9));\n repository.save(new NoteBook(\"HP Inspiron\", 299.9));\n repository.save(new NoteBook(\"Dell Magic\", 300));\n repository.save(new NoteBook(\"Apple MacBook\", 709.9));\n repository.save(new NoteBook(\"LG D230\", 299.9));\n repository.save(new NoteBook(\"Acer P700\", 199.9));\n\n log<\/em>.info(\"Initial records inserted into database.\" );\n } catch (Exception e) {\n log<\/em>.info(\"Error in initiating records into database.\" );\n }\n };\n }\n else\n return args -> {\n log<\/em>.info(\"Records already initiated \");\n };\n }\n\n\n\n\n}<\/code><\/pre>\n\n\n\n Test endpoints with H2 database<\/h2>\n\n\n\n
package bdp.sample.notebookmanager.controller;\n\nimport bdp.sample.notebookmanager.entities.NoteBook;\nimport bdp.sample.notebookmanager.repositories.NoteBookRepository;\nimport com.fasterxml.jackson.databind.ObjectMapper;\nimport org.junit.jupiter.api.BeforeEach;\nimport org.junit.jupiter.api.Test;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.boot.test.autoconfigure.web.client.AutoConfigureWebClient;\nimport org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;\nimport org.springframework.boot.test.context.SpringBootTest;\nimport org.springframework.test.annotation.DirtiesContext;\nimport org.springframework.test.context.ActiveProfiles;\nimport org.springframework.test.context.jdbc.Sql;\nimport org.springframework.test.web.servlet.MockMvc;\n\nimport javax.annotation.Resource;\nimport javax.sql.DataSource;\n\nimport java.sql.SQLException;\n\nimport static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;\nimport static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;\n\n\n@SpringBootTest\n@ActiveProfiles(\"test\")\n@AutoConfigureMockMvc\n@AutoConfigureWebClient\n@Sql(executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD<\/em>, scripts = \"classpath:beforeTestRun.sql\")\n@Sql(executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD<\/em>, scripts = \"classpath:afterTestRun.sql\")\n\/\/@DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_EACH_TEST_METHOD)\nclass NoteBookControllerTest {\n\n\n @Autowired\n MockMvc mockMvc;\n\n @Autowired\n DataSource dataSource;\n\n\n\n\n\n @Test\n void getListOfnotebooksWithConfigurablePageSize() throws Exception {\n \/\/ First page with page size of 2\n mockMvc.perform(get<\/em>(\"\/api\/notebooks?page=0&pageSize=2\")).andExpect(status<\/em>().isOk())\n .andExpect(content<\/em>().contentType(\"application\/json\")).andExpect(jsonPath<\/em>(\"$._embedded.noteBookList[0].id\").value(\"1\"))\n .andExpect(jsonPath<\/em>(\"$._embedded.noteBookList[1].id\").value(\"2\"));\n\n \/\/ Second page with page size of 3\n mockMvc.perform(get<\/em>(\"\/api\/notebooks?page=1&pageSize=3\")).andExpect(status<\/em>().isOk())\n .andExpect(content<\/em>().contentType(\"application\/json\"))\n .andExpect(jsonPath<\/em>(\"$._embedded.noteBookList[0].id\").value(\"4\"))\n .andExpect(jsonPath<\/em>(\"$._embedded.noteBookList[1].id\").value(\"5\"));\n\n }\n\n @Test\n void getSingleExistingnotebookById() throws Exception {\n\n \/\/ Get notebook with id=2\n mockMvc.perform(get<\/em>(\"\/api\/notebooks\/2\")).andExpect(status<\/em>().isOk())\n .andExpect(content<\/em>().contentType(\"application\/json\"))\n .andExpect(jsonPath<\/em>(\"$.id\").value(\"2\"))\n .andExpect(jsonPath<\/em>(\"$.name\").value(\"HP Inspiron\"));\n\n }\n\n\n @Test\n void getSingleNotExistingnotebookById() throws Exception {\n\n \/\/ Get notebook with id=22\n mockMvc.perform(get<\/em>(\"\/api\/notebooks\/22\"))\n .andExpect(status<\/em>().isNotFound());\n\n }\n\n @Test\n void getSinglenotebookByInvalidnotebookId() throws Exception {\n\n \/\/ Get notebook with id=i\n mockMvc.perform(get<\/em>(\"\/api\/notebooks\/i\"))\n .andExpect(status<\/em>().isBadRequest());\n\n \/\/ Get notebook with id=*\n mockMvc.perform(get<\/em>(\"\/api\/notebooks\/*\"))\n .andExpect(status<\/em>().isBadRequest());\n\n }\n\n @Test\n void updatenotebookWithExistingnotebookId() throws Exception{\n\n NoteBook notebook = new NoteBook(2,\"HP FitBook\",305.99);\n ObjectMapper objectMapper = new ObjectMapper();\n String json = objectMapper.writeValueAsString(notebook);\n \/\/ Update notebook with id = 2\n mockMvc.perform(patch<\/em>(\"\/api\/notebooks\/2\").content(json).characterEncoding(\"utf-8\")\n .contentType(\"application\/json\"))\n .andExpect(status<\/em>().isAccepted())\n .andExpect(jsonPath<\/em>(\"$.name\").value(\"HP FitBook\"))\n .andExpect(jsonPath<\/em>(\"$.currentPrice\").value(305.99));\n }\n\n\n @Test\n void updatenotebookWithNotExistingnotebookId() throws Exception{\n\n NoteBook notebook = new NoteBook(77,\"HP FitBook\",305.99);\n ObjectMapper objectMapper = new ObjectMapper();\n String json = objectMapper.writeValueAsString(notebook);\n \/\/ Update notebook with id = 77 which is not existed\n mockMvc.perform(patch<\/em>(\"\/api\/notebooks\/77\").content(json).characterEncoding(\"utf-8\")\n .contentType(\"application\/json\"))\n .andExpect(status<\/em>().isNotFound());\n\n }\n\n\n @Test\n void createnotebook() throws Exception{\n\n NoteBook notebook = new NoteBook(\"HP FitBook\",305.99);\n ObjectMapper objectMapper = new ObjectMapper();\n String json = objectMapper.writeValueAsString(notebook);\n\n \/\/ Create new notebook\n mockMvc.perform(post<\/em>(\"\/api\/notebooks\").content(json).characterEncoding(\"utf-8\")\n .contentType(\"application\/json\"))\n .andExpect(status<\/em>().isCreated());\n\n }\n\n @Test\n void createNoteBookWithDuplicateName() throws Exception{\n\n NoteBook notebook = new NoteBook(\"Dell B3\",305.99);\n ObjectMapper objectMapper = new ObjectMapper();\n String json = objectMapper.writeValueAsString(notebook);\n\n \/\/ Create new notebook with duplicate name\n mockMvc.perform(post<\/em>(\"\/api\/notebooks\").content(json).characterEncoding(\"utf-8\")\n .contentType(\"application\/json\"))\n .andExpect(status<\/em>().isConflict());\n\n }\n\n @Test\n void deleteNoteBookWithExistingNoteBookId() throws Exception{\n\n \/\/ Delete notebook with id = 2\n mockMvc.perform(delete<\/em>(\"\/api\/notebooks\/2\"))\n .andExpect(status<\/em>().isAccepted());\n }\n\n\n}<\/code><\/pre>\n\n\n\n Creating Docker image and container <\/h2>\n\n\n\n
FROM openjdk:8-jdk\nEXPOSE 8090\nWORKDIR \/app\n\n# Copy maven executable to the image\nCOPY mvnw .\nCOPY .mvn .mvn\n\n# Copy the pom.xml file\nCOPY pom.xml .\n\n# Copy the project source\nCOPY .\/src .\/src\nCOPY .\/pom.xml .\/pom.xml\n\nRUN chmod 755 \/app\/mvnw\n\nRUN .\/mvnw dependency:go-offline -B\n\nRUN .\/mvnw package \n#RUN ls -al\nENTRYPOINT [\"java\",\"-jar\",\"target\/NoteBookManagerRest-0.0.1-SNAPSHOT.jar\"]<\/code><\/pre>\n\n\n\nversion: '2.1'\n\nservices:\n #service 1: mysql database image creation\n <\/em>db:\n image: mysql:5.6.17\n container_name: mysql-db \n environment:\n - MYSQL_ROOT_PASSWORD=spring\n ports:\n - \"3306:3306\"\n restart: always\n healthcheck:\n test: [\"CMD\", \"mysqladmin\" ,\"ping\", \"-h\", \"localhost\"]\n timeout: 20s\n retries: 10\n\n \n # service 2: NoteBook Manager app image creation\n <\/em>notebookervice:\n image: notebook-service\n container_name: notebook-service-app # name of container created from image\n <\/em>build:\n context: . # path to docker file\n <\/em>dockerfile: Dockerfile # docker file name\n <\/em>ports:\n - \"8090:8080\" # stock service port\n <\/em>restart: always\n\n depends_on: #define dependencies of this app\n <\/em>db : #dependency name (which is defined with this name 'db' in this file earlier)\n <\/em>condition: service_healthy\n environment:\n SPRING_DATASOURCE_URL: jdbc:mysql:\/\/mysql-db:3306\/notebook_manager?createDatabaseIfNotExist=true&useSSL=false\n SPRING_DATASOURCE_USERNAME: root\n SPRING_DATASOURCE_PASSWORD: spring<\/code><\/pre>\n\n\n\ndocker-compose up<\/code><\/pre>\n\n\n\n