placing your order...
Don't refresh or navigate away from the page.
choose your plan
pro
monthly
annual
$24.99
$249.99
only $20.83 per month
- share your subscription with one other person
- access to all Manning books, MEAPs, liveVideos, liveProjects, and audiobooks!
- choose another free eBook every time you renew
- choose twelve free eBooks per year
- exclusive 50% discount on all purchases
-
![]()
Document and Validate an API eBook for free
Document and Validate an API eBook for free
team
monthly
annual
$49.99
$499.99
only $41.67 per month
- five seats for your team
- access to all Manning books, MEAPs, liveVideos, liveProjects, and audiobooks!
- choose another free eBook every time you renew
- choose twelve free eBooks per year
- exclusive 50% discount on all purchases
-
![]()
Document and Validate an API eBook for free
Look inside
You’re a senior developer at Travel World Agency (TWA), which has grown to become the largest travel agency in the world. The company has built a next-generation system that uses a microservice architecture running on Amazon Web Services (AWS). But while TWA’s success is on the right track, the performance of its reservation microservice is off the rails. As a solution, TWA has replaced the microservice with a new one, using Kotlin and Spring Boot to improve performance and maintainability. Your job is to document the API endpoints for this new microservice—following the Open API 3 standard—to reduce the risk of someone invoking the endpoints incorrectly. You’ll also create custom rules for validating the documentation in an external library, allowing for reuse in other projects across the company.
This project is designed for learning purposes and is not a complete, production-ready application or solution.
book resources
When you start your liveProject, you get full access to the following books for 90 days.
prerequisites
This liveProject is for Java and Kotlin developers interested in learning to improve the quality and robustness of their applications. To begin these liveProjects you’ll need to be familiar with the following:
TOOLS- Any IDE: IntelliJ IDEA, Eclipse
- Basic Spring and Spring Boot
- Intermediate Maven
- Basic Docker and Docker Compose
- Basic knowledge of Java or Kotlin
- Basic knowledge of Spring Boot and how to add new modules
- Basic Docker and Docker Compose commands
- REST principles
- Basic knowledge of microservices
you will learn
In this liveProject, you’ll learn to document and validate the API endpoints for a microservice, following the Open API 3 standard.
- Create a new endpoint to expose the documentation of the microservice
- Document the different endpoints which need to follow the Open API 3 standard dynamically
- Add a library that checks if the documentation follows the standard or not using predefined rules
- Extract the steps related to the validation so that you can do the validation manually or in a pipeline by running a specific command
- Create custom rules to validate certain aspects of the documentation
features
- Self-paced
- You choose the schedule and decide how much time to invest as you build your project.
- Project roadmap
- Each project is divided into several achievable steps.
- Get Help
- While within the liveProject platform, get help from other participants and our expert mentors.
- Compare with others
- For each step, compare your deliverable to the solutions by the author and other participants.
- book resources
- Get full access to select books for 90 days. Permanent access to excerpts from Manning products are also included, as well as references to other resources.
