using swagger to generate documentation for laravel 8

see hi welcome back to my channel in this video I'm going to show you how to create a documentation for whatever using social the first thing you're going to do is clog my Repository due to IDI OT and then install the dependency for the software you can find the dependency in readme.md and run composer required air force yourself just follow this step and you're gonna discuss yourself for me after a couple of minutes it starts itself only and then you need to run off sir you need to add the slide of course to your out of PSP let's gonna go to config.sp and cut this lie and then you need to run PSP Edition to publish the provider of the advanced water safely and then to generate a documentation for his for usbi you're gonna go to HTTP controller in the main controller you need to pass the line the man in fall is to worsen of your idea the title and the description you can copy from my phone charity demois and then in the to do controller you're gonna defy the documentation for its API uh here example of the create API this have I think deeper treatment first thing is the path of your HPI is API to do store the time is at the group of the API and I will try to remove Rune PSP Edition or if same nervous and run DSP Edition to accept the documentation you need to go or in the config file of this watcher config and password and you're gonna find the keyword the URL oh no forget something here is the route the keyboard in your mouth and you're gonna copy this one and go to the browser and accept your server passenger here is the documentation for your hbi the to do the time to the time is the path of the API API to the store click on it here is the path of the API API to the store and you're going to define the the body of the API when you submit to the API this body View sent to your server here is because body in the Cricut body you're going to Define what type of the body in my scenario is application decision the schema is the schema is this thing is the object go include turtle and content property the property is total is the name contain the tie of the property string or number or something you can accept the official documentation of the structure oh here is the example in the example you can try everything you want to do the it's important is to the developer the front end developer can try to run it if you want to run it you can click on try on it try it out and then you can modify your body and skill he is the response from your server in spawn to love will reduce my problem or else a title Charter is social is it is a service respond the status 200 for physical body here and in some case you can create the example response for the front window s on APC set or you fail we start the course you can Define it in the response this spot you have yes in my example this is simple we will generate this example here or you can as another response if you want or maybe 200s and it's really simple to create another response oh you can transform this you know this oh if you want the objective messages probably you can tell plus two symbol fail after you can after you modify the notification documentation you need to run this command to regenerate the document at the end on your server cool invest in value of another notice for the API this structure is the request button if you have a boost API you you're gonna ask an additional param for the API URL in my case is the ID you can try it to generate these program in the mid individual you need to define something like this update to do in the update to do API here you need to define the ID and the parameter for your heater for the past in in pass or Hitler or something on and the property the name name here is equal to the URL required true or fail the tie is G just a lot of create API and the response you could you can write something everything you want so this documentation will generate this API yeah you can be to try id4 four let's give processor oh you see Power you can get the detail of the studio by typing the ID of the to do you want you you will get entire skill this will respond the detailed to do or you can get the list let's try our skill in the oh not another a here is the defy of the tie of the mentor it puts and this is the gas mentors and the let me talk you will Define here and or if you if you want generous another URL for documentation you can join this in here you can type in for V1 too dead I think you lost to regenerate the documentation and start again oh four zero four who a oh it is simple right and if you find some nothing for you says [Music] okay it does it it's simple you could you can go on my project in the Repository and try to write something in here I will put the URL of the repository in the description of the video and the next video I'm gonna show you how to separate API version in some project you gonna have different opposition such as with one or V1 dot two or three or whatever you want and next video I'll give you so that's the problem thank you for watching my video I'll see you next time bye

Channel: TechSharing

Views: 26,782

Keywords: todo list api, swagger api, laravel document api, laravel 8

Id: p3Z3RR091Wk

Length: 13min 36sec (816 seconds)

Published: Sun Dec 12 2021