Okay,
on the screen, I have the GitHub account for the OpenAPI specification.
So this is where all the source code behind the OpenAPI lives.
It lives inside of this GitHub repository.
I will provide a link to this in the course resources so you can go right here.
Now there's a few things I wanna point out in here specifically for the course that we are gonna
be taking a look at. If you come in here and take a look at the examples directory inside a GitHub can
see that we have version 2.0 and 3.0.
Again I'm not focusing on 2.0 but I am gonna be looking at 3.0.
Here are a number of different examples.
Remember we looked at petstore so here's the petstore. YAML has the OpenAPI specification.
You can see that there's several different implementations of the OpenAPI specification that we can
look at.
So some really good examples when you need to see how to do something you can go through and review
these and let's go back over here. Then the next thing we wanna take a look here is this IMPLEMENTAIONS
this markdown file here IMPLEMENTATIONS. These are known implementations for OpenAPI3.0.
We can see that there's a number of tooling that's been set up in different programs that are available.
This list is always growing. I highly recommend taking a look at it and there's different technologies
that are available.
I'm primarily a Java developer so you can see a number of Java tools there.
I can barely spell Ruby but there are Ruby tools there, Node.js, Typescript, PHP. So a large number of
tools that we have available.
Remember I said that we are gonna be using the SwaggerHub editor.
Here are some specific tools for working with OpenAPI.
Some specific editors. A lot of people like Visual Studio.
I've actually used this one here at the top Visual Studio Code extension is quite nice. So you might
prefer to use Sisual Studio.
It's a free tool that is an editorial that you can use.
And I actually know of some that are not actually available here so this is not a complete list by any
means, there is actually additional tooling that is not on this list.
Then you can see here User Interfaces.
So these are tools that we'll take in the OpenAPI specification and give you documentation.
So we've already seen swagger-ui in action.
And here are some additional options.
So Widdershins that is a quite popular.
As far as generating end user documentation from your OpenAPI specification, I personally like Redoc
quite a bit.
This is a very nice tool for generating and user documentation from your OpenAPI specification and
now you can also see we have Server Implementations, Client Implementations, Code Generators.
So there's a number of different code generators that you can utilize with the OpenAPI specification.
Let's take it back over here.
And remember I said that the OpenAPI specification is backed by a formal schema.
Here is the JSON schema.
If you wanna go through and see exactly,
this is where you can really take a look at how the OpenAPI schema is defined this is the raw source
code for that so to speak but we'll be looking at this through a different approach. I'm not gonna get
too deep on that it's come back over here and then finally I highly recommend going through this documentation
that there's a lot of documentation to this.
You can see tools and libraries participation how it is licensed if you wanna contribute to this
project it is an open source project.
So they even have a technical steering committee developing guidelines so the lot here obviously I'm
not gonna go through every single thing we're just talking about trying to get up to OpenAPI and
you can see here that we are currently on 3.0.2.
And if I click to this, this link is actually gonna take me in two versions.
So but I'll just go ahead and click on this.
This is the documentation for the OpenAPI schema and we will be getting very very familiar with this.
Specifically we are gonna be looking at developing against the OpenAPI schema and we will be looking
at the specific like the OpenAPI object. You can see here this is the top-level schema specification
and we will be going through this in upcoming videos.
This documentation here for OpenAPI is very rich it's very detailed and you should consider this document
and the single source of truth for when you're working with OpenAPI documentation.