Skip to main content

Create REST API Documentation with Swagger UI using PHP, Part 4 - #31


Like what you see, support the channel.

Published: September 07, 2020


Estimated Reading Time
2 minutes
Video Duration
23:23 minutes

Become a Patreon to show support and get exclusive access to content: https://www.patreon.com/devdrawe

In the last video, we installed Swagger to our API. This video, we will start building out the comments that will create the dynamic documentation the showcase the REST API usage.

This documentation is user-friendly and interactive so your developers can work directly with the API based on the needs of your code. This tutorial will give over the usage of OpenAPI GET, PUT, POST, and DELETE so you can label and use your API documentation correctly.

0:00 Intro

02:12 Adding OpenAPI variables for POST

05:00 Adding Form Data Requests to POST

09:25 Adding Multiple Form Data Requests to One Route

09:25 Adding Multiple JSON Data Requests to PUT

12:40 Adding Examples to Help Users

16:40 Switching from POST to PUT

18:49 Adding OpenAPI variables for DELETE

20:13 Other Things You Can Do With Swagger

Applications Used

Visual Studio Code v1.43: https://code.visualstudio.com/

WAMP v3.2.0: http://www.wampserver.com/en/

Swagger UI: https://swagger.io/tools/swagger-ui/

Computer Hardware:

Windows 10 Pro: https://amzn.to/3q5TyZw (Amazon)

Samsung 500GB External SSD: https://amzn.to/2ViAAAF (Amazon)

Samsung 970 EVO Plus SSD 1TB - M.2 NVMe: https://amzn.to/36jDwDy (Amazon)

Rosewill Hive-750S R750W PSU: https://amzn.to/36jiDbs (Amazon)

Phanteks Eclipse Tempered Glass Case: https://amzn.to/39qou0B (Amazon)

MSI Arsenal Gaming AMD Ryzen Motherboard: https://amzn.to/36hpAKm (Amazon)

MSI Gaming GeForce RTX 2060 Super 8GB: https://amzn.to/36hMyRm (Amazon)

LG 34UM69G-B 34-Inch 21:9 UltraWide IPS Monitor: https://amzn.to/2HSRxyI (Amazon)

Corsair 64GB (4 x 16GB) DDR4 Memory: https://amzn.to/3mlmQkI (Amazon)

AMD Ryzen 7 2700X Processor: https://amzn.to/3qdQIBF (Amazon)

Dell XPS 15 9500 15.6" Laptop / Windows: https://amzn.to/3fKEz2w (Amazon)

Lenovo ThinkPad T15 15.6" Laptop / Linux: https://amzn.to/2Jnmn33 (Amazon)

Camera:

Fujifilm X-T3: https://amzn.to/3llKBb5 (Amazon)

Fujinon XF18-55mmF2.8-4: https://amzn.to/3mfTkNb (Amazon)

Audio:

Audio Technica AT2020: https://amzn.to/2VgxU6K (Amazon)

Blue Snowball iCE: https://amzn.to/3lo1jGC (Amazon)

DISCLAIMERS:

I am a participant in the Amazon Services LLC Associates Program, an affiliate advertising program designed to provide a means for us to earn fees by linking to Amazon.com and affiliated sites.