Scribd
Upload
47 views16 pages

Open APIs

Uploaded by

sainiharsha001
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
47 views16 pages

Open APIs

Uploaded by

sainiharsha001
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 16

The F u t u r e is

exciting..
The F u t u r e o f E d u c a t i o n is h e r e

Understanding OPEN APIs

Submitted By :- Submitted To :-
Ujjwal Tyagi Bhanu Pratap Sir
Harsh Saini
www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
What are Open APIs ?

API Blueprint It's a guide for creating and explaining APIs.

Machines and humans can both understand it . Think of it as a


“recipe” for your API.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Why should you care about Open API ?

No Guessing: Everyone knows how the API works.

Time-Saving: Automates boring tasks.

Error-Free: Makes APIs more reliable.

Team-Friendly: Helps developers, testers, and businesses


work together.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
How Open API Looks (Simple Example)
Let’s see how OpenAPI describes an end point:

yaml
Copy code
openapi: 3.0.0
info:
title: Weather API
version: 1.0.0
paths:
/current:
get:
summary: Get current weather
responses:
'200':
description: Weather details

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Main Parts of OpenAPI

Info: The title, version, and details of your API.

Paths: Where your API goes (e.g., /users, /products).

Responses: What comes back when someone uses your API.

Components: Reusable pieces (like Lego bricks).

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Tools to Work with OpenAPI

Swagger Editor: Make your OpenAPI specs easily.

Postman: Test your APIs.

Redoc: Turn specs into pretty documentation.

Mock Servers: See how your API works before coding.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Imagine Building an API for a Shopping App
yaml
Copy code
paths:
/products:
get:
summary: List all products
responses:
'200':
description: A list of products
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
price:
type: number
www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
What can OpenAPI Do for You ?

For Developers: Generate code automatically.

For Testers: Test API responses without asking developers.

For Businesses: Faster launches and happier teams.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
OpenAPI vs Manual Documentation

Manual Docs:

Lots of typing, prone to errors.


Gets outdated quickly.

OpenAPI:

Always up-to-date.
Machines and people can read it.
Saves time and effort.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Cool Real Life Uses of OpenAPI

GitHub uses it for their API documentation.

Stripe uses it for payments APIs.

Microsoft Azure uses it for cloud APIs.

(Logos/icons of these companies can be added


here.)

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Tips for using OpenAPI

Start small and simple .

Use tools to check for mistakes.

Update your specs as your API grows.

Break large APIs into smaller pieces.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Challenges with OpenAPI

It can feel tricky at first.

Large specs can get messy.

Need to keep it updated with your code.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
OpenAPI is like a Bridge

Connects developers, testers, and users.

Makes APIs easier, faster, and better.

Helps everyone stay on the same page.

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED
Thank You! Questions?

www.quantumuniversity.edu.in
INNOVATE EMPOWER PERSEVERE SUCCEED

You might also like