API Design Patterns

Product Catalog API you own this product

This project is part of the liveProject series Create APIs Using API Design Patterns
prerequisites
web services basics • familiarity with RESTful and REST services • basics of microservices concepts and applications • basics of APIs and interfaces, payloads, JSON, and XML • Java programming skills
skills learned
design a product catalog API by following a design-first approach and using OpenAPI Spec • master the basics of OpenAPI Specification, YAML syntax, schema definitions • generate helpful API documentation
Harihara Subramanian
1 week · 6-8 hours per week · INTERMEDIATE
Included with a Manning Online subscription
try now

pro $24.99 per month

  • access to all Manning books, MEAPs, liveVideos, liveProjects, and audiobooks!
  • choose one free eBook per month to keep
  • exclusive 50% discount on all purchases

lite $19.99 per month

  • access to all Manning books, including MEAPs!

team

5, 10 or 20 seats+ for your team - learn more

Look inside

You’re a software developer for Greengrocer, a chain of supermarkets that’s revamping its monolithic software to better handle its growing customer base. Using a design-first approach and the OpenAPI Specification, your task is to design a product catalog API to help employees track inventory. You’ll write API definitions through YAML description files and generate code and documentation for the API. When you’re done, you’ll have firsthand experience with OpenAPI Specification, YAML syntax, and schema definitions, and you’ll have improved the developer experience with good documentation.

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.

project author

Harihara Subramanian J

With a proven track record in software development, software architecture principles, and implementations, Hari Subramanian has been working with software development and various software architecture concepts since 1999. He’s designed and developed over 20 microservice applications adhering to API design principles and API design patterns and has an affinity for patterns and anti-patterns.

Cloud native computing, cloud architecture, legacy product transformations, cloud migration strategies, and cloud design patterns are his current areas of focus. He’s also an active contributor to various forums on different technologies and has co-authored the books Architecture Patterns and Hands-on RESTful API Design Patterns and Best Practices.

prerequisites

This liveProject is for learners who want to gain practical experience with RESTful APIs, microservices, design principles, and API design patterns. To begin these liveProjects you’ll need to be familiar with the following:

TOOLS
  • Any Java IDE
  • JDK 8 or higher
TECHNIQUES
  • API Design-First
  • Open API Spec
  • SLA and payloads
  • JSON
  • XML

you will learn

In this liveProject, you’ll learn to design a product catalog API by following a design-first approach and using OpenAPI Specification.

  • Design a product catalog API by following a design-first approach and using OpenAPI Spec
  • Master the basics of OpenAPI Specification, YAML syntax, and schema definitions
  • Generate helpful and comprehensive API 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.

choose your plan

pro

monthly
annual
$24.99
$249.99
only $20.83 per month
  • access to all Manning books, MEAPs, liveVideos, liveProjects, and audiobooks!
  • choose another free product every time you renew
  • choose twelve free products per year
  • exclusive 50% discount on all purchases
  • Product Catalog API project 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 product every time you renew
  • choose twelve free products per year
  • exclusive 50% discount on all purchases
  • Product Catalog API project for free