Skip to main content

Install Swagger UI Documentation for Your PHP RESTful API, Part 3 - #30


Like what you see, support the channel.

Published: August 31, 2020


Estimated Reading Time
2 minutes
Video Duration
24:01 minutes

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

Now that we have looked at the custom PHP REST API, we need to create documentation. To do this, I will be using Swagger UI. In this tutorial, we go over how to install Swagger and Swagger PHP in order to dynamically populate your interactive documentation.

With Swagger, you can create documentation for your REST API that is detailed, useful and allows your developers to test in realtime.

Swagger UI is free and easy to get started with. So, let's install Swagger and start documenting our API.

0:00 Intro

02:39 Install Zircote PHP Swagger from GitHub

05:39 Add OpenAPI structure to Page Class

10:17 Create Documentation Folder and Add api.php

11:22 Change from YAML to JSON

13:56 Install Swagger from Github

20:21 Testing Our First Response

21:47 Upcoming: Using GET, POST, PUT, DELETE

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.