OpenAPI 3.0: How to Design and Document APIs with the Latest OpenAPI Specification 3.0

The OpenAPI Specification (OAS), based on the original Swagger 2.0 specification, has emerged as the world’s standard for defining and describing RESTful APIs. Learn more about OpenAPI 3.0 here: www.slideshare...
Get started with OpenAPI 3.0 in SwaggerHub for free: swaggerhub.com/
The next version of the OAS - version 3.0 - is officially released, and comes with a host of rich, expressive capabilities for your API design and documentation. Some of these capabilities include support for describing callbacks, links to express relationships between operations, enhanced examples, and a simplified structure.
In this free SwaggerHub training, we look at what’s new in OAS 3.0, and show a live demo of defining APIs using OAS 3.0 in SwaggerHub.
We will cover:
• What’s new in OpenAPI 3.0?
• Transitioning from Swagger 2.0 to OAS 3.0
• Designing an API using OAS 3.0 on SwaggerHub
• Collaborative approach to API design and documentation with OAS 3.0 in SwaggerHub
Subscribe to all SmartBear videos here: www.youtube.co...

[@lifeLoges]

The time is approximate 01:17 Why ? 04:20 Solution 05:28 What is OpenAPI and what is swagger 06:09 What is new on OAPI 3 06:51 Specification restructure and improve usability -- 08:10 Parameters -- 09:11 Contact negotiation 09:37 Demo -- 09:37 Overview -- 10:21 Planning -- 11:10 How they going to build it ( tools) -- 12:10 How to create API in swagger hub 50:17 Resources and Q/A

[@keshavvasudevan6774]

Thank you all for the amazing feedback! We really appreciate it!

[@itsfrx2143]

Well explained man!

[@AmeenAltajer]

Amazing explanation!

[@ajnikhil]

why have a fake accent ? were you born in US?

[@dannavarez1372]

Love the way it was explained. Straightforward. No flowering words. Direct to the point. Appreciated much.

[@isurucumaranathunga]

Within last 2 days I was searching for a resource to learn open API specification and swagger and this is the best tutorial I had ever found. very straight forward and to the point. Thanks for this content.

[@vishnudas4995]

That's how one should explain things, awesome and conceptually clear.

[@kwameadoko9542]

A few years ago, I check the date on a post, the number of views and comments to watch a video on youtube (If it has a long date, fewer views, likes, and comments, GONE!). But with time I have come to realize some videos are just not meant for everyone. But this video, GREAT ✌🏽

[@sukeshc]

Nice ! Short,crisp and clear

[@ddgupta5514]

Excellent tutorial for the beginners...

[@valecmeza]

This is just what I needed to learn how to create an API spec. Straight to the point. Thank you!

[@vy9076]

Very clear and up to the point. Just shows how documentation is SO important

[@raywachaga]

A rare gem. Thank you sir!

[@abcdeika]

Great tutorial. Loved it. Got a better understating of OpenAPI from this 1h video rather than reading for hours some course-tutorial. Like!

[@vijayb1620]

Very nice and detail presentation ...!!! GOOD Job Keshav

[@niyatimanish121]

Thank you for explaining this so well! Needed it.

[@ThiagoOliveira-pk7ci]

Good presentation. The only weird thing is that you post the employ ID on Post trigger. But thanks for the video.

[@timmi00007]

Simply cool. It certainly gives a jump start to API Development especially with 3.0. Thanks!

[@eugenefriday2039]

Well structured, great explanation, and excellent example! Saves time reading myriads of documentations.

[@Sasikumar8]

Keshav neenga vera level boss.

[@nareshbalimidi6219]

Thank you soo much...I created my first API by watching this video...this is really helpful...

[@pramodsinghyadav7580]

great explanation with practical point of view.

[@poreddyvemareddy3685]

Clear explanation. Thanks 🙏

[@ShubhamGupta-re1go]

Thanks , very clear explanation

[@gowinidea]

Thank you very much for sharing this knowledge. Appreciated!

[@chandansarkar1123]

Very cool introduction to the subject matter. Thanks a lot for the video

[@Name-lt2tz]

any good tutorial on how to use those with php attributes in symfony instead of writing in yaml?

[@kusumrawat4735]

can u share best practices of openAPI Specification

[@abdulmatin1598]

It was really a great introduction.

[@germantellez2710]

Excellent presentation. I have one question, how do you know what words write? where can i find the glossary o list of words allowed? I'm new designing API with swagger

[@Smartbear]

Thank you! This tutorial will help you with writing OAS definitions: app.swaggerhub.com/help/tutorials/openapi-3-tutorial

[@cptechno]

You don' mention where you are getting the names and level of all fields you are typing.

[@michaelcanavan4324]

Very clear, thank you.

[@SN-zr3rf]

Dear All/Host of this Video, Good you please provide details about How to secure this REST API while it is being hosted in public domain?

[@wasimhbaig]

Thanks Keshav, very nicely done...

[@donovanfaber9211]

Thanks for the video, so helpful in starting out! I do have a question though, when you create and use your $ref, why are you not getting an error that there is a sibling value (in your case type) alongside your $ref? What would be the best way to handle this? Thank you again, awesome stuff!

[@HandledToaster2]

Hey, I know I'm late but the solution is to put the "type: object" in the "Employee" inside components, right under description, just like he did for "Employees" where "type: array" is there. Then erase "type: object" from the rest of the code.

[@briankhuele1558]

Awesome explanation!!! Thank you so much and shout out to the swagger team ;)

[@AbhishekSharma-ed4vo]

Hi I liked the video. Thanks for sharing. I have a specific question: if we have a crud operation to return true/false, how we will modify the response for it? Also how to add the pagination to the specific crud operation let's say GET operation? Any help on that will be much appreciated..

[@deepgandhi1106]

Here, I can not found answers, what I'm looking for. I have several queries. It will really help me if anyone can answer. 1) Suppose, I have a schema for Project model which contains 20 properties. Now for my project-dropdown API I only need 3 properties from the schema then how I can refer the schema and pick few properties only? 2) I have 2 schemas, one for Project with 20 properties and another one is Task with 10 properties. Now for ProjectDetails API I have response something like { id: 1, name: "ProjectName", tasks: [ {id: 1, name: "TaskName"} ] } Now how I can accomplish this nested object by referring both individual schema which are Project and Task 3) Can I have search box in Swagger UI to filter APIs?

[@Faiz-canada]

Excellent presentation. Hats off !!! Just one thing , it is possible to provide sample request and response rather than defining object and array ?

[@DenFri91]

Thanks for the great tutorial. How do i use OAuth2 client credentials for secure server to server communication? I cant find a proper tutorial or documentation for this. Most of them has their focus on user interaction.

[@BeforeAndAfterScience]

"Your API's no longer a black box, there's actually a RESTful interface that allows your clients to actually interact with the data or service you want to expose." Tell me you don't understand what a black box is without saying you don't understand what a black box is.

[@Amol175]

How I can secure the nodejs generated stub

[@alagappannarayanan6635]

Nice demo

[@basamnath3021]

Excellent video

[@sinigeorge7485]

Could you please share how to create error schema for http error codes

[@aashishjuneja350]

Well explained..... Thanks for sharing wonderful knowledge

[@vpremanand]

Good presentation... have a question... "servers" tag, is it mandatory to define the host servers in the open api yaml definition file? maybe when we do publish these apis to be used through URLs, but most of the cases (dev, test, etc) while defining the APIs these info is not static isn't it?

[@tejashavale8085]

can we hide parameters from the UI?

[@mfolarin]

Blessed tutor. Thanks!

[@karviworld7627]

Quite descriptive

[@ajit555db]

Great presentation. Is there one for advanced modeling too?

[@004akshay]

thank you Keshav..

[@abdelkrimboureche7192]

Thank you for this excellent video.

[@myselfMaky]

Can anyone help to understand how to test the OpenAPI?

[@SoundOfYourDestiny]

At 36:00 I don't think this is the type of parameter you want to put in a path. An employee ID is a great example of a query parameter; not something from which you want to build a unique endpoint with. A path parameter would contain values like "evaluations," "taxDocuments," insuranceElections," "projectHistory..." These are things that define entire subsets of data about their parent.

[@mcdonaldslover52]

what if you were building a portal for employees where they can view tasks assigned, store personal documents, view & update their personal details. All of that would fall under an employee entity

[@SoundOfYourDestiny]

@@mcdonaldslover52 Indeed, I'm not sure I agree with my past opinion on this anymore.

[@design7054]

Great intro, thank you.

[@supunbatagoda8061]

Is they are any way to hide Schema/Models from API Documentation in SwaggerHub?

[@AmolGautam]

Thank you so much

[@rice_polygriffe]

That's good. Following your exact steps, I am getting these errors : Schema error at paths['/employees'].post.requestBody should have required property '$ref' missingProperty: $ref Jump to line 65 Schema error at paths['/employees'].post.requestBody should match exactly one schema in oneOf Jump to line 65 Schema error at paths['/employees'].post.requestBody.content['application/json'] should be object Jump to line 67 Schema error at paths['/employees'].post.requestBody.content['schema'] should NOT have additional properties additionalProperty: type, properties Jump to line 69

[@mrstanlez]

Next question is, how to use it OFFLINE ?

[@Ravi-Software-Engineer]

Nicely explained..!!

[@ravisankarjampani213]

Excellent

[@mrstanlez]

The question is, why I need OpenAPI 3.0 ? Cause every company have own requirements.

[@byteslinger3187]

very good video but It honestly had me wishing there was a 5x speed on youtube

[@harshalagrawal03]

how to handle the situation of multiple path parameters

[@saikiran4]

I"ve generated petstore api using the openapi generator but can anyone explain how to write the code implementation of it by using json/yaml format? it is only creating the interfaces and controller classes which returns http response as not implemented.(I'm using springboot)

[@chandrakantbhavar98]

I want use servers , currently we have 4 env. and I want to execute few api based on 1 server, few api on other server. Can I do this using openapi 3.0.0

[@recordable542]

extremly helpful!

[@narenkv74]

Do you have a product like swagger which generates OAS 3.0 specifications

[@Smartbear]

Hi Narendra! Yes we do. You can check out Swagger Inspector here: swagger.io/swagger-inspector/

[@SzTz100]

Bro, why you generating swagger docs by hand?

[@koraytugay]

How else can he generate if implementation does not exist yet?

[@SzTz100]

@@koraytugay Spend time on the implementation, then auto-generate the swagger docs using a framework, otherwise just time wasting.

[@design7054]

What's the usual best practice alternative to craeating swagger docs by hand?

[@SzTz100]

@@design7054 I use FastAPI for Python and Swashbuckle for .net core, they both autogenerates auto-generates the swagger docs for me. I've never needed to hand-code swagger docs.

[@pfigueiredoytb]

Great video :)

[@rajkrishnamurthy4978]

Good presentation. Thanks.

[@manishjakhode9541]

How to define same api resource for multiple roles for example register api for user role normal_user, custom_user, admin and so on? could you please let me know?

[@Smartbear]

The components section of the specification can be referenced multiple times swagger.io/docs/specification/using-ref/. Swaggerhub takes this to the next level by storing these reusable assets in a separate file, allowing them to be used across multiple APIs app.swaggerhub.com/help/domains/index. I hope this helps!

[@manishjakhode9541]

Thanks for your reply. but both the links that you have shared with me not working. so could you please let me know how to do that?

[@Smartbear]

Here you go, let me know if these do not work for you: swagger.io/docs/specification/using-ref/ & app.swaggerhub.com/help/domains/index

[@vivekrawatvlogs]

I am getting a warning "Sibling values are not allowed alongside $refs" after adding the reference to Employee model. Any idea why?

[@robell1954]

I got this too, after some playing about, and commenting out type: object it seemed to get rid of the compilation warning. However, I haven't got to the end of the video as yet, so don't know if this will have any other knock on effect... 200: description: Successful user info retrieved content: application/json: schema: # type: object $ref: '#/components/schemas/Users'

[@durgaraju8018]

how to connect this API to a oracle database and how can we manipulate the data in oracle database through this API designed.

[@jb42192]

Great explanation :)

[@zaccomusic]

amazing content friend

[@FileHorsecom]

Great video! All the best

[@seenuarunandirajendran4677]

Well explained !!

[@jhonatanmd8587]

Buen vídeo , pero hubieras probado el api en swagger

[@shripal.modani]

Thank you so much!

[@CynthiaToussi-hw5zj]

Bonjour je suis nouvelle sur les api rest et il m'a été demandée de réaliser la documentation open Api d'un diagramme de classe je voudrais savoir comment on fait

[@yaashchauhaan]

I need to know how to implement pagination .. can anyone help me pls ?

[@Smartbear]

While recording, click on "New Page" within the Instaplay Recorder.

[@keshavvasudevan6774]

You can implement pagination using linking. Learn more here swagger.io/docs/specification/links/

[@aiautoglasscrm]

Your demo was great, why? first you showed in action. and second you explained clearly what we can do. only limited by our imagination.

[@ThomasLunsford]

It was impossible to open this video fullscreen on the swagger.io site. Couldn't right click. Couldn't click anywhere near the youtube controls. Was this on purpose?

[@design7054]

Preview window shows: "We're sorry, but an error occured in this component. Please check the console for details."

[@linhledieu5403]

31:05

[@Name-lt2tz]

is this still relevant? 7 years passed, but looks like in symfony current it still is used OAS 3.0 . Weird.

[@ahmadmostafa46]

33:42 because you are using Windows LOL

[@maxime9728]

test

[@rayamonoes]

test

[@klaasjegamer]

test

[@sc06mad]

okay my name is Rajeet and now we will talk about a shitty pee pee request

[@kennethcarvalho3684]

An Indian and an American I think!!