API Blueprint Advanced – Creating Complex API Specs & Docs
APIs are everywhere. I have designed & build many highly scalable SaaS-based applications using RESTful APIs. API Design & Documentation play an important role in any complex mobile or SaaS-base application.
In this course we will learn how to conceptualize the complete notes-management system and write its RESTful API specification using API Blueprint. We will also learn how to convert or render that blueprint into beautiful 3-columns API Documentations.
This course has been created for the people who are:
- Project Managers
- Product Managers/Engineering Managers
- API Designers
- API Testers
For their complex product design and implementation of RESTful APIs using api blueprint.
In this course we will see everything from ground level to up (ie. from 0 to 10) including setting up editor and writing the blueprint. We will also learn about advanced features of blueprint like:
- JSON Schema
- MSON Schema
- URI Parameters
- Data Structures
- File inclusion
- Relation Types
- API Mock Server
- Postman Collection
After this course you will be able to break down any real life SaaS-based or mobile apps in to scalable RESTful APIs which can be used anywhere.
Introduction & Overview
This current lecture to understand what are we going to learn in this course. We will explore the lecture by lecture and explain why it is important to learn whatever we are learning.
Here we will see what we will create during the course. We will be creating the notes management APIs for anyone on web. We will use complex JSON schema & Data Structure to define the response.
Here we will be understanding what exactly RESTful APIs are & also understanding what are API Blueprints.
Here we will learn what is the typical Blueprint Document’s structure while creating the specs of APIs.
In this Lecture we will be quickly going through the basics of API Blueprint.
Here we will be learning the JSON schema & how as well as why it matters in API designs.
Here we will be learning about the MSON (Human version of JSON) and see how API Designs uses MSON.
Here we will learn about the URI Templates in API Blueprint & how to use them in complex API designs.
Here we will learn how to include external markdown syntax files or JSON schema into your blueprint.
Here we will be learning about the Attributes & Data Structures in API Blueprints & how to specify them and also use them in API designs.
Here we will be launching an API Mock Server using the API Blueprint we have designed in the course.
Here we will be converting our API Blueprint we have just created into the Postman Collection to perform actions on APIs using Postman (A tool for API Testing)
Here we will be uploading our API Blueprint to the Apriary project & view the documentation online5
Here we will be Summarizing what we have build and demonstrate it.