Document a REST API with OpenAPI and Stoplight Studio

Поделиться
HTML-код
  • Опубликовано: 6 окт 2024

Комментарии • 25

  • @Beachcasts
    @Beachcasts  5 лет назад

    Check out this starting video from the series I created to build a REST API with Expressive: ruclips.net/video/2ESAi2vq-80/видео.html

    • @Beachcasts
      @Beachcasts  5 лет назад

      Also, here is a link for the entire playlist of that series: ruclips.net/p/PL6_nF0awZMoMol4RPLf99WIZuoJ3l87oG

    • @SeadoooRider
      @SeadoooRider 4 года назад

      @@Beachcasts Thanks for the video. And I see you keep on apologizing, in fact, I can see in my wide monitor. It's absolutely readable. :)

  • @amanze
    @amanze 4 года назад +8

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

    • @Beachcasts
      @Beachcasts  4 года назад

      You're welcome, glad it helped. Thanks for watching.

  • @SergeySerkin
    @SergeySerkin 4 года назад +1

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

    • @Beachcasts
      @Beachcasts  4 года назад

      Thanks for watching. Enjoy. There has been more improvements to Stoplight Studio since this recording.

  • @shahjahanravjee8639
    @shahjahanravjee8639 4 года назад

    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!

  • @safeshka_8566
    @safeshka_8566 2 года назад

    Thank you for your guide.

    • @Beachcasts
      @Beachcasts  2 года назад

      You're welcome. Thanks for watching.

  • @vktop2
    @vktop2 2 года назад

    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

    • @Beachcasts
      @Beachcasts  2 года назад +1

      Thank you for watching. The Spotlight teams have done much since I released this video. Is recommend checking the current documentation to answer your questions. I believe they also have ways to contact them if you still need answers. Good luck.

  • @agent4140
    @agent4140 4 года назад

    Awesome content! Thank you

  • @ojastrivedi843
    @ojastrivedi843 3 года назад

    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

    • @Beachcasts
      @Beachcasts  3 года назад

      That is the idea behind the OpenAPI spec. It should remain the same on any system. Stoplight studio, Postman, server, etc.

    • @ojastrivedi843
      @ojastrivedi843 3 года назад

      @@Beachcasts Thanks for the quick response. But if I host it with the help of Prism mock server then it is only showing the Raw json response. I want it to look like the same UI as stoplight is showing but it will be hosted on my portal not on Stoplight portal.

  • @alexandrageocadin2235
    @alexandrageocadin2235 4 года назад

    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.

    • @Beachcasts
      @Beachcasts  4 года назад +1

      I would recommend you reach out to the folks at Stoplight. They always answer quickly.

  • @SergeySerkin
    @SergeySerkin 4 года назад

    Thx!

    • @Beachcasts
      @Beachcasts  4 года назад

      You're welcome. Thanks for watching.

  • @reenaranghar8570
    @reenaranghar8570 4 года назад

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

    • @reenaranghar8570
      @reenaranghar8570 4 года назад

      Could you show how the document look Like wen we publish the output .

    • @Beachcasts
      @Beachcasts  4 года назад

      Sorry Reena. Maybe reach out to the Stoplight team. They are very responsive.