API Blueprint - Design API Specs & Create Docs in Seconds

Name: API Blueprint - Design API Specs & Create Docs in Seconds
Rating: 3.8 (26 reviews)

[No Coding] Learn to Design & Create RESTful API Specs through Blueprints & convert them in awesome API docs in seconds

Created byToshendra Sharma

Last updated 8/2017

English

What you'll learn

Design their own APIs Blueprints for their product's APIs
Create, Share & Host API Docs effectively with less hassle
Create their own products from scratch using API Blueprints

Course content

3 sections • 8 lectures • 56m total length

Intro & Overview4:27
This current lecture is 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.
What we will be designing?3:03
Here we will see what we will design during the course. We will be designing or writing the APIs specifications for a basic user management system using API blueprint. We will also convert those API Specs into beautiful documentation.

What are RESTful APIs & API Blueprint?8:32
Here we will be learning what are RESTful APIs & also explore what exactly API blueprint is. We will also learn the other alternatives of API blueprint like RAML & Swagger.
Setting up the Editor & Rendering Tool6:31
Here we will be setting up the blueprint editor & also install the open source tool for converting the api blueprint into beautiful 3 column api documentation.
API Metadata, Name & Description13:37
Here we will start writing the API Blueprint & will see how to start with format specification, meta data, name, end point & description.
Resource Groups, Resource & Action13:29
In this Lecture we will write the resource groups, resources & their respective actions based on HTTP methods.
URI Template & Parameters3:29
Here we will be learn how to put variables in URI template & parameters to specify more data in requests.

Requirements

Basics of APIs

Description

Hello Everyone, I am Toshendra Sharma, your instructor.

In this (Non-coding) course you will learn how to design or write the actionable RESTful API specifications using API Blueprints. We will also learn how to convert/render them into awesome actionable 2-3 column API docs using a tool within a second & host them live on internet.

You can use the APIs specs to hire a freelancer developer to implement the server side code & pay them based on the specifications.

This course has been created for the people who are:

Project Managers
Product Managers/Engineering Managers
API Designers
API Testers
Entrepreneurs
Students

For their projects/products to define the specifications of RESTful APIs & also it's documentations which can be embedded anywhere to build the full fledged product. This one hour course will quickly let you build the specifications in one small .apib doc & let you convert into .html page which can be shared with anyone or hosted anywhere.

This API blueprint can also be used to host the API docs at Apiary directly.

If you are excited to create awesome API documentations within an hour then join in the course and learn to build RESTful APIs quickly. This course is perfect for anyone wanting to get theirs hands on APIs.

Who this course is for:

This course is for Product Manager who are exploring best way to design APIs
This course is also targeted for Engineering Managers
This course is for API Designer, CTOs, Web Developers who are looking to design effective APIs quickly
This course is also for technical writers who are looking for easy method to manage API docs online

API Blueprint - Design API Specs & Create Docs in Seconds

What you'll learn

Explore related topics

Course content

Introduction2 lectures • 8min

Designing APIs & Implementation5 lectures • 46min

Summary1 lecture • 3min

Requirements

Description

Who this course is for: