What you'll learn
- Build High Quality RESTful APIs and API Documentat
- Learn What is API First Engineering and Why its Important
- How to Leverage OpenAPI as the Single Source of Truth
- Use OpenAPI Code Generation to Generate Java Code
- Use Redocly for CI Builds of your OpenAPI Specification and Documentat
Explore related topics
Course content
- Course Introduction1:54
- Instructor Introduction2:29
- Getting the Most Out of Your Course4:18
Block out a dedicated hour, complete the course with hands-on practice, finish quizzes and assignments, join the Slack community, and enroll to receive the Spring Framework Guru newsletter.
- Setting Up Your Development Environment4:01
- Is Your IDE Free Like A Puppy?2:45
- Free 120 Day IntelliJ Ultimate Trial0:43
- Course Slack Room - Chat with Your Instructor and Other Students0:50
- Github Workflow12:20
Master the GitHub workflow for this course by forking the repository, cloning to your local workspace, and using master and ending branches to compare changes.
- Introduction1:11
- Defining API First7:34
- API First for Organizations7:46
API first for organizations treats the API as the company's product, demanding product-grade quality, organizational alignment across marketing, product, and engineering, and well-documented, interoperable APIs.
- API First Best Practices9:13
Learn API-first best practices by treating the OpenAPI specification as the contract and single source of truth, validating, linting, and generating code to ensure governance and alignment.
- API First Quiz
- Introduction1:35
- Introduction to OpenAPI & Redocly6:44
- Create API Documentation Repository5:31
- GitHub Dependbot Updates2:28
- Github Development Branch2:09
Create a development branch in GitHub, set it as the default, and tie the open API specification and documentation to this baseline for an API-first Spring Boot project.
- Add to Redocly API Registry4:53
- Customize API Specification8:28
- Assignment - Update Specification
- Introduction1:43
- RESTFul API Design6:20
- Introduction to Domain Driven Design8:56
- Application Design Overview6:59
- Add List Cutomers Operation7:11
- Complete Customer Schema5:06
- Add Get Customer By Id Operation3:27
- Assignment - Add Get Operations for Product
- Add Order Get Operations6:58
- Create Order Schema5:10
- Introduction2:17
- Add Schema Constraints to Customer4:22
- Add Required Properties to Customer4:00
- Add Examples to Customer4:45
- Define Create Customer Endpoint6:23
- Mark Nullable Properties on Customer6:38
- Assignment Add Constraints to Product and Order
- Refactor DateTime to Common Object4:30
- Introduction2:03
- Hexagonal Architecture5:40
- Create New Maven Project3:14
Create a new Maven project in IntelliJ for a Spring Boot workflow, establishing a multi-module build with an open API specification source generation module and a Spring Boot module.
- Create API Module and OpenAPI Code Generation6:31
- Redocly Security Configuration3:24
Troubleshoot illegal argument exceptions when deserializing OpenAPI YAML by adjusting Redocly security settings to allow public access, then generate Java POJOs with the OpenAPI code generator for Maven.
- Code Generation Configuration3:48
Configure the open api code generation plugin to use Jackson, select rest template, and disable docs and tests to generate only pojo models.
- Add Maven Dependencies4:42
- Enable Bean Validation4:09
Enable bean validation by configuring the plugin and using hibernate validator 8.0 with the Jakarta namespace, then add Jakarta annotations for open api constraints used by spring boot.
- Assignment: Update Package for Model Classes
- Remove JsonNullable1:56
Explore how to disable json nullable in the OpenAPI generator to stop wrapping nullable properties with jackson data bind nullable wrapper, by setting open API nullable to false, improving models.
- Add Project Lombok4:28
- Update Dimensions to Use Integer4:40
- Introduction0:59
- Add Spring Boot Module3:32
- Add API Module Dependency6:00
- Create Customer Repository3:00
- Initialize Customer Data7:11
Initialize customer data by seeding an in-memory hash map repository with a builder-pattern customer and address objects, simulating a spring data persistence layer during bootstrap.
- Create List Customer Endpoint10:47
- Create Get Customer by Id Endpoint4:15
- Assignment - Implement Product Get Endpoints
- Assignment - Implement Order Get Endpoints
- Introduction1:43
- Create Test for List Customers5:01
- Test Get Customer by Id2:28
- Swagger Request Validator Dependencies3:58
- Swagger Request Validator With MockMVC7:00
- Assignment - Validate Product Get Endpoints
- Assignment - Validate Order Get Endpoints
- Introduction1:25
- Assignment - Update Specification to OpenAPI 3.0
- Create Product API Specification4:25
- Implement Create Product API7:03
- Assignment - Create Customer API
- Add Create Order to OpenAPI Specification9:54
- Implement Create Order API7:57
Implement a create order api by wiring an order create object with customer and product lookups, enforcing 201 responses per open api specification, and validating with the swagger request validator.
- Fix Failing Order Tests5:12
- Refactor OpenAPI Schema3:14
Clean up the open api schema by correcting tag names, fixing the selected payment method id, and correcting misspellings in dimensions and product properties, with code updates and GitHub commits.
- Introduction1:22
- ORM Overview6:42
- Refactor to Use DTO Naming4:33
- Maven Dependencies2:56
- Customer Entity3:25
- Embedded Entities2:46
- One to One Relationships2:32
- One to Many Relationships2:56
- Audit Timestamps1:46
- Assignment: Product Entity
- Many to Many Relationships2:48
Implement a category entity and map a bidirectional many-to-many relationship with product, using default Hibernate mapping and a join table that stores both entity IDs.
- Create Order Entity6:20
Requirements
- Should be familiar with Spring Boot and Spring MVC
- Basic Java Development Skills and Able to Use Maven
- Working Knowledge of OpenAPI
Description
Take a comprehensive dive into the world of API First development using Spring 6 and Spring Boot 3. This extensive course covers the latest practices and tools for designing, building, and testing robust APIs following industry best practices.
You'll begin by understanding the foundational concepts of API-first development and its benefits for organizations. The course then guides you through the practical implementation of an API using OpenAPI specifications, domain-driven design principles, and code generation from OpenAPI specifications.
Throughout the course, you'll explore a wide range of topics, including:
Defining APIs using the OpenAPI specification and tools like Redocly
Using Redocly to establish CI/CD builds for your OpenAPI Specification and Redoc API Documentation
Applying domain-driven design principles for effective API design
Generating code from OpenAPI specifications using Maven with OpenAPI Code Generator
Developing Spring Boot and SpringMVC to implementing API endpoints
Testing APIs with Spring MockMVC and incorporate request validation to your OpenAPI Specification
Implementing create, update, patch, and delete operations for APIs
Object-relational mapping with JPA, Hibernate
Using MapStruct for efficient object mapping and type transformation
Enforcing data validation and constraints with JPA and Java Bean Validation
Handling standardized problems and errors with libraries like Zalando Problem
Generation of Spring Boot API clients and using clients with integration testing
Throughout the course, you'll work on a real-world e-commerce API project, applying the concepts and best practices learned in each section. By the end of this course, you'll have a deep understanding of API-first development using Spring 6 and Spring Boot 3 with OpenAPI, enabling you to design, build, and test robust APIs that adhere to industry standards.
This course is a master course in developing high quality world class API products for your customers.
Enroll now and elevate your skills in API development with Spring!
Who this course is for:
- Spring Developers Responsible for Building Customer Facing APis
- Developers Seeking to Build High Quality APIs
- QA Engineers Wishing to Improve API Code Quality
- API Product Owners Responsible for the Delivery of Customer Facing APIs
