
Meet John Thompson as he welcomes you to the OpenAPI course and outlines a comprehensive, hands-on journey from history and basics to defining services and building a strong API schema.
Fork the spring framework guru repository on GitHub, then clone it locally, use branches to compare your work with the lesson state, and follow the workflow.
Explore core OpenAPI concepts, define what an API is, and review HTTP and RESTful APIs at a high level to prepare documenting with OpenAPI, YAML, and reusable components.
Learn why you wish to use OpenAPI in your organization
Discover how the OpenAPI specification uses YAML to define information, operations, and parameters in Swagger Editor, and how Swagger UI renders and tests pet store endpoints.
Explore the evolution from Swagger to OpenAPI 2.0 and the transition to OpenAPI 3.0, focusing on reusable components, major objects, and practical hands-on guidance for building APIs.
Master YAML basics for OpenAPI specifications. Learn about keys and values, comments, nesting, sequences, and literals, and choose editors to avoid spacing pitfalls.
Explore the OpenAPI specification through a practical tour of the official GitHub repository, key 3.0 examples, tooling, editors, and documentation for API design.
Explore how OpenAPI extends JSON schema to describe data types and structures in APIs, comparing JSON, XML, and YAML, with string formats, numeric constraints, objects, arrays, and schema combinations.
Explore OpenAPI data types, including integer, number, string formats, and boolean, and learn how schema objects with minimum and maximum constraints and nullable properties define API data.
Explore how OpenAPI objects become nested schemas to model a customer with firstName, lastName, address, a uuid-formatted id, and Swagger UI examples for robust API documentation.
Learn how to organize OpenAPI operations with tags to group endpoints like customers and beers, enabling flexible, multi-tag documentation and clear versioning in swagger-ui.
Describe how to return a location header in a 201 created response for a new resource, using a headers object in OpenAPI and providing the URI of the created customer.
Describe additional responses in OpenAPI to set expectations for API consumers, documenting 400 bad request, 404 not found, 409 conflict across post, get, put, and delete operations.
Explore how OpenAPI callbacks work by configuring a beer order workflow with an orderStatusChange webhook, posting a JSON payload to a specified URL and handling a 200 response.
Set up a jwt bearer token authentication in an OpenAPI spec by adding a jwt auth token security scheme, enabling bearer format, and applying it to all endpoints.
Explore how OpenAPI defines security requirements for RESTful APIs and leverages widely accepted standards, then preview code generation tools, Java clients, and Spring-based server stubs via Swagger Hub.
See how OpenAPI acts as a valuable standard for public facing restful APIs, with tooling that can generate source code from the OpenAPI specification for clients like PHP.
OpenAPI 3.0 is the leading tool for the documentation of APIs.
Formerly known as Swagger, OpenAPI has a long and established history. In 2010, Swagger started as an open source specification for designing and documenting RESTful APIs.
In 2015, the Swagger project was acquired by SmartBear Software. The Swagger Specification was donated to the Linux foundation and renamed the OpenAPI.
The OpenAPI specification is the cornerstone of a thriving open source community. Simply perform a search for OpenAPI tools and you will find projects for converters, documentation, validators, editors, mock servers, testing tools and much much more!
From the OpenAPI specification, you can generate client side source code for over 50 languages. You can generate server side code for over 40 different languages.
All of these open source contributes start with the OpenAPI specification, which we explore in depth in this course.
You start off the course with learning about what is an API, a review of the HTTP protocol and how it is used in respect to RESTFul APIs.
Then we start looking at OpenAPI and how it applies to documenting RESTFul APIs.
We then start writing an OpenAPI specification using Swagger Hub.
Swagger Hub is a free, easy to use on-line editor for Swagger and OpenAPI specifications.
You will get to create a complete OpenAPI specification for a RESTful web service.
Step by step, you learn how to:
Edit a OpenAPI specification in Swagger Hub
Define a OpenAPI specification in YAML
Add developer information
Add server information
Define an API path
Define an API operation
Create robust objects with JSON schema constraints
Improve the quality of your specification with re-useable components.
Define query parameters
Define path parameters
Define GET, PUT, POST, and DELETE operations
Create API security schemes
Generate source code with OpenAPI Code Gen
Use ReDoc to generate robust API documentation
Use Apache Maven to generate code with OpenAPI Code Gen
This course has numerous assignments and hands on examples to get you comfortable writing OpenAPI specifications.
Course Extra - Access to a Private Slack Community
You're not just enrolling in a course --> You are joining a community learning about using OpenAPI.
With your enrollment to the course, you can access an exclusive Slack community. Get help from the instructor and other gurus from around the world - in real time! This community is only available to students enrolled in this course.
This is a very active Slack community with almost 500 Gurus!
With your enrollment, you can join this community of awesome gurus!
Closed Captioning / Subtitles
Closed captioning in english is available for all course videos!
PDF Downloads
All keynote presentations are available for you to download as PDFs.
Lifetime Access
When you purchase this course, you will receive lifetime access! You can login anytime from anywhere to access the course content.
No Risk - Money Back Guarantee
You can buy this course with no risk. If you are unhappy with the course, for any reason, you can get a complete refund. The course has a 30 day Money Back Guarantee.
Enroll today and see how easy it is to use OpenAPI for your RESTFul APIs!