in Mobile, Web

Getting Started with OpenAPI Specification and Swagger


Below are my notes on a presentation I have given on designing RESTful APIs with Open API Specification. I also cover some popular open source tools from Swagger, namely the Swagger Editor, Swagger UI, and Swagger Codegen.

For an introduction on building and API with OpenAPI spec, check out my openapi-swagger-demo repository. The repo contains 4 examples, including:

  • A Sample API built with swagger-node
  • A documentation site using swagger-ui that runs off the OpenAPI spec on the sample API
  • A Codegen example demonstrating how to build a TypeScript client SDK based on the sample API
  • A sample Angular site that connects to our sample API via the codgen-built client SDK.

Presentation Slides Coming Soon