Swagger API documentation tutorial for beginners - 2 - How to use swagger online editor

welcome to your second API documentation tutorial using swagger in this tutorial we'll be walking through the whole documentation process using swagger if you can observe in this diagram this is a human being and let us assume for a moment that this is you there are two ways you can start creating your documentation for your swagger API the first is that you can use the editor online which is editor put swagger dot IO when you visit it you will start writing young as you can see in this diagram you visit editor plus vulgar dot IO and you start writing yomo yomo will be converted automatically to an interface HTML and CSS that you can see and but before then it gets first converted to jason and then from jason to HTML and CSS so this website automatically does it for you so if we change the title of this website right here from pesto pesto one you can observe the changes right here it has changed to pesto one so as you know documenting your API is here you can see there is a whole lot of documentation to do here it will be updating itself right here as a beautiful API documentation platform alright but this is just the editor in the end you want your users to only see this and they don't have to see this code if we get back to a diagram will observe that after this we have to manually download this the JSON file installs like a UI in a local system then point it to this JSON file and but importantly then we upload to our websites and that is what users see our users basically see our swagger UI now apart from brindis online we can do this offline too so to do that offline we have to close one editor from youtube.com and then we'll write llamo the llamo will be displayed on it just looks exactly like this as we are right on the llamo it will get displayed on the right side as HTML and CSS but for us to use it in saga UI which will have to clone and download again we will have to manually convert it to Jason and import it but senses it's on our desktop we can write a gulp task now convert it automatically so as we're writin it's getting automatically converted to Jason and we've seen it in Alps like a UI it's that simple and straightforward then once we're true we can upload if our API changes we go through the whole process again come to our code editor update the Yama file our gob task automatically of converted to Jason and save it in our saga UI then we upload so every time we'll just update IMO file we'll just go straight and upload so that is the process flow of building your API documentation using swagger if you understand this the rest of this video will be very easy for you to flow alright so in the next video tutorial we'll be looking at how to write this yellow and understanding the swagger or put API specification I will show you in the next video that thank you very much and don't forget to subscribe

Channel: Braintemple Tutorial TV

Views: 81,356

Keywords: cakephp, laravel, framework, php, html, web, evelopment, rapid

Id: scVliTfB3bU

Length: 4min 3sec (243 seconds)

Published: Tue Jun 20 2017