Building APIs with Swagger and the OpenAPI Specification

Learn how to build and document high-quality APIs with Swagger and the OpenAPI Specification.

Introduction

• Building APIs with Swagger
• What you should know
• Demo project overview
• Updates to this course

1. Swagger Ecosystem

• Swagger ecosystem
• Open-source tools
• OpenAPI Specification
• Open-source tool installation
• H+ Sport intro
• Building a simple API
• Challenge: Retrieve company blog posts
• Solution: Retrieve company blog posts

2. Building API Specifications

• Defining APIs
• Reading the specification
• Paths with query parameters
• Template parameters in paths
• Building posts with request bodies
• Achieving reusability with components
• Response objects
• Reusing parameters
• Content negotiation
• Swagger UI
• Challenge: Create company blog posts
• Solution: Create company blog posts

3. Creating and Publishing APIs with SwaggerHub

• Building APIs within SwaggerHub
• Getting started with SwaggerHub
• Building API definitions from templates
• Versioning APIs in SwaggerHub
• Importing API definitions
• Security schemes
• Domains
• Nesting schemas in domains
• Enforcing API standards
• Auto Mocking APIs
• Adding organization members
• Inviting individual collaborators
• Challenge: Publish the blog API
• Solution: Publish the blog API

4. Capstone Project

• Project architecture
• Generating server stubs and client SDKs
• Building an API client
• Client SDK internals
• API implementation
• Packaging the API implementation
• Hosting APIs in Azure
• API server setup
• Publishing public APIs
• API management with Apigee
• Monitoring API usage
• Client modifications

Conclusion

• Next steps