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

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

Associated Links:

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:

Help through referrals:

#openapi #stoplightstudio #beachcasts

[amanze]

God bless you Man!
You just solved one of my biggest headaches. Documenting API with YAML.
O! the horror!!!

[SergeySerkin]

I used to create api specification in swagger editor, but i see that creating in Stoplight Studio is more comfortable and clearly

[shahjahanravjee]

Good Turtorial. @Here if you want to change the font on the stoplight studio use Ctrl+Shift+= to Zoom In and Ctrl+- to Zoom Out. Hope this helps!

[ojastrivedi]

That's a great tutorial. Have one question. Can we host this Open API specification onto any developer portal of my own and it should look same as it is in the Stoplight studio. Or we can get any .md files and host that.
Would be great if someone helps. Thank you so much

[alexandrageocadin]

Hi, I have a question. I followed your tutorial but why am I getting this error?
( OpenAPI object should have non-empty 'tags' array. )

Thank You.

[reenaranghar]

I would like to create one API document but facing issue in publishing..can plz you help?

[vktop]

Hi! Excelent explanation and good product, but I have some questions 1 . Can I integrate Stoplight Studio with Github or Azure DevOps? 2. Does Stoplight Studio allow me to create mocks based on my API definition? 3. Does Stoplight allow me to test my API based on the definition? 4. Does Stoplight allow me to store the API definitions and share them? 5. Does Stoplight allow me to define domains, teams, and organizations? thank you