API Documentation and Why it Matters
Ғылым және технология
As you know from our other videos on technical documentation, writing docs is an extremely important part of creating software that users will love. But what if developers are the users? Let’s talk about API documentation and why it matters
0:00 Devs are users
0:50 API economy
2:28 What is API documentation?
5:03 How to write API documentation
8:37 API documentation examples
More about API Documentation:
www.altexsoft.com/blog/api-do...
www.altexsoft.com/blog/busine...
Learn more about AltexSoft: www.altexsoft.com
Follow us on LinkedIn: / altexsoft
Follow us on Facebook: / altexsoft
Follow us on Twitter: / altexsoft
Follow us on Instagram: / altexsoftcom
Sources:
[ 1 ] investor.salesforce.com/press...
[ 2 ] www.postman.com/company/about...
[ 3 ] swagger.io/specification/
Music in video by EpidemicSound (www.epidemicsound.com)
In this video, we use characters from the cinematic universe "Star Wars" by Lucasfilm (www.lucasfilm.com/)
Пікірлер: 23
the entire video felt like a movie which is amazing because it helped me concentrate on the video without getting distracted despite how tired i am. truly a great (and enjoyable) video
@AltexSoft
4 ай бұрын
Thanks so much ♥
man this channel is a gen
Amazing video,really dig the Star Wars/LEGO references.Great work!
Thank you for the content!
This is god level content, that too for free
Great video! Could you record more about QA in software development? Ideally "roles in software QA" ;)
@AltexSoft
Жыл бұрын
Hi. Thanks for your feedback. We don't have such video yet, but you can read our article dedicated to QA engineering roles www.altexsoft.com/blog/engineering/qa-engineering-roles-skills-tools-and-responsibilities-within-a-testing-team/
We want videos on api strategy and what does this api documentation contain
next video request probably strategies how to capitalize or profit from API's?
@AltexSoft
Жыл бұрын
We wrote about API economy on our blog www.altexsoft.com/blog/api-economy/
Hey, We would like to view what are the process of software development, for example after planning all the software what range of diagrams are needed to create in frontend and backend and when
@AltexSoft
Жыл бұрын
Thanks for the suggestion, we’ll consider creating a separate video on product development process!
@Pythonnaire
Жыл бұрын
@@AltexSoft I am waiting for this.
Suppose I have my open api spec in YAML, is there an app/website/tool to help publish my documentation without building it from scratch? paid or free doesnt matter
@AltexSoft
10 ай бұрын
Sure, try Postman or Swagger. They both automatically generate docs from your Open API definitions
very very very niceeeeeeeeeeeeeeeeeeeeeeee vid
@AltexSoft
4 ай бұрын
A huge huge thaaaaaanks
Api pricing and monetization
i feel like i am actually watching a movie than IT boring doc
@AltexSoft
10 ай бұрын
♥
Im gonna give you my honest opinion. You could have deliver the same content in 5 minutes video.
That glitchy sound on almost every transition is really annoying