Document a REST API with OpenAPI and Stoplight Studio

How to document a REST API with OpenAPI and Stoplight Studio. (see shortcuts below to key points) Adam Culp of Beachcasts php programming videos shares how to document REST APIs using the OpenAPI convention (formerly known as Swagger) with an OpenAPI gui editor.

I'm sorry for not being able to make the fonts larger for the interface in this video.

Please * LIKE, COMMENT, AND SUBSCRIBE * - and share with others!

Key Topics:
- Document a REST API with OpenAPI convention (also known as Swagger)
- How to use Stoplight Studio

For a nice list of equipment I use in my studio, and to support the channel if you make any purchases (doesn't cost you a thing), visit my kit at kit.co: https://kit.co/beachcasts/beachcasts-studio

Errata:
Let me know if you notice anything that should be errata

Associated Links:
https://beachcasts.com
https://stoplight.io
https://swagger.io/docs/specification/about/
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md

Timeline:
00:00 Video Intro
00:57 Introduction to Stoplight Studio
01:04 How I installed the IDE
02:46 Create an API project in Stoplight Studio
03:26 Name the API
03:40 Change between light and dark theme
04:06 Enter basic info about the API
06:35 Add configuration for an API Path
07:20 Make a call to the API from the IDE using Try It.
08:20 Add an expected response content for the API GET request
09:17 Add in a sample response Body for a GET request
09:55 Define the data scheme that should be in the GET response
10:40 Specify format and other properties for data scheme items
16:53 How to add additional HTTP methods to the documentation (POST, PUT, DELETE)
17:45 Add an optional path parameter to the GET requests
19:25 Add a UUID to the request and test

Other Beachcasts videos you might find interesting:
Conference Talk Preparation In 8 Steps for Programmers https://youtu.be/wRwKWKD38g0
How to understand code written by someone else https://youtu.be/lj6GH6yWSlk
Ways to advance your programming skills and improve as a developer https://youtu.be/X6abVw8SlZc
Make your local DEV environment available on the internet https://youtu.be/xs2o7B_Ex9E
AWS Elastic Load Balancer (ELB) Tutorial How-To https://youtu.be/Sr2Mq9Gegew
Laravel Model Factory Tutorial using Artisan make:model https://youtu.be/hM135dPJ1dM
Authentication in Laravel Tutorial https://youtu.be/2qJkzWJNpjQ
Top 5 skills to be a better software developer https://youtu.be/kbX8iATLqxs
Install Laravel in Docker container on Ubuntu for beginners https://youtu.be/0HTruhilvcU
Getters and Setters accessors in object oriented programming https://youtu.be/cozignPaoLg
Critical programming issues preventing a PHP 7 upgrade https://youtu.be/z13glyDnm6s
Behat for beginners functional REST API testing tutorial https://youtu.be/nFNGDhyFrm4
Doctrine ORM one-to-many bi-directional association https://youtu.be/4nEdBDxBc1w
PHP Mess Detector static analysis to find PHP code smells https://youtu.be/8fEfHESrK5E
Doctrine ORM one-to-many self-referencing association https://youtu.be/4dHZ6cZooOk
10 reasons to become a consultant in a consulting business https://youtu.be/J7gpMYAKmDM
Zend Framework becomes Laminas project at Linux Foundation https://youtu.be/CEIO90ocEDI
10 bad things about consulting https://youtu.be/ELE0G3e7h3c
How to get lines of code in PHP https://youtu.be/HpC-Cvxj6oY
Make a List handler middleware https://youtu.be/VLqavHCFv6g
Make a Delete handler middleware https://youtu.be/3nLbQfMk99k
Make an Update handler middleware https://youtu.be/3Zcq5Jjz1Po
Use UUID with Doctrine ORM for DB keys https://youtu.be/SYuLwMwSIpg
Make a Create handler middlware https://youtu.be/FIYh-VIWUko
Automate Hypermedia creation for PHP REST API https://youtu.be/dX6S-pJVUXI
Learn about Hypermedia and how to create it https://youtu.be/aV6ro_JXL_A
Doctrine ORM Paginator for PHP REST API https://youtu.be/UpqOew4sNT0
Doctrine ORM Entity how to https://youtu.be/NnK9Geg1h_E
Configure Doctrine ORM https://youtu.be/pFvh5ZNhdOQ
Create PHP middlware with Zend Expressive https://youtu.be/26440j7D0BE
Configure PhpStorm for PHP development with Docker https://youtu.be/FQWL-JTZvf4
Create PHP development environment with docker https://youtu.be/2ESAi2vq-80

Help through referrals:
Thinking of buying a Tesla electric vehicle? Use this referral link to also get six months of free Supercharging for both of us. Thank you. https://www.tesla.com/referral/tanya21367

I use TubeBuddy to help me manage my YouTube channel. If you're interested, click the following link to check it out. https://www.tubebuddy.com/beachcasts

#openapi #stoplightstudio #beachcasts