YouTube2Text

How to Use Apidog | All-in-one Collaborative API Development Platform — Transcript

by Apidog · 2,516 words · 365 segments · language en · Watch on YouTube

Full transcript

  1. 0:00hi welcome to API do your all-in-one
  2. 0:03collaborative API development platform
  3. 0:05this video is designed for those who are
  4. 0:07new to API Doc and I will walk you
  5. 0:10through a core functions to ensure you
  6. 0:12quickly craft the key features of API do
  7. 0:16so we will start by exploring how to
  8. 0:18make an API call then move on to
  9. 0:21designing and developing apis after that
  10. 0:23we will explore API do smart mock
  11. 0:26function and finally we will conclude
  12. 0:28the tutorial with an overview of API
  13. 0:30docs automated testing and API
  14. 0:32documentation so without further Ado
  15. 0:35let's get
  16. 0:37started after completing the signup
  17. 0:39process when you open API Dog app you
  18. 0:41will find yourself on this interface now
  19. 0:44to make an API call Select new request
  20. 0:47then just paste your URL in and click
  21. 0:50Send now if the API request runs
  22. 0:53smoothly all you have to do is click
  23. 0:56here and select save as API just give it
  24. 0:59a name and save that's it API dog will
  25. 1:03automatically create an API
  26. 1:04specification for you covering the path
  27. 1:07parameters responses and examples
  28. 1:09creating an API specification in API Doc
  29. 1:12is as easy as that it is recommended to
  30. 1:15save the request as an API because API
  31. 1:18Doc is more than just a platform for
  32. 1:21sending API request it's a comprehensive
  33. 1:24API development platform designed with
  34. 1:26API design first approach in
  35. 1:28mind
  36. 1:30okay moving forward we will explore how
  37. 1:33to design an API at API doc we
  38. 1:35recommends API design first approach
  39. 1:37just now I demonstrated how to call an
  40. 1:39API I will now create a new API from
  41. 1:42scratch to do that let's select new API
  42. 1:45and enter pet slid okay and you can see
  43. 1:49here the path parameters are
  44. 1:50automatically detected later the name
  45. 1:53like demo status tags and description
  46. 1:57can be filled in very easily then we can
  47. 1:59start start defining our API generally
  48. 2:02most of the companies will have common
  49. 2:03data structure like code message and
  50. 2:06data you can see that my API
  51. 2:08automatically has it if you are
  52. 2:10wondering why is that because API do
  53. 2:12provides a very useful feature called
  54. 2:14default response template as long as the
  55. 2:17template is set the new API in your
  56. 2:19project will automatically have it now
  57. 2:21you may ask the data of each API
  58. 2:24probably going to be different but to do
  59. 2:26that you can click here and select
  60. 2:28schema reference then select a sample
  61. 2:31schema like pet so while defining our
  62. 2:35API we can easily refer to some of the
  63. 2:37commonly used data structure in our API
  64. 2:39all you need to do is pre- them in this
  65. 2:42schema section so that we can reference
  66. 2:44them in the API now in the example
  67. 2:47section let's click add example and
  68. 2:50select success case and then just hit
  69. 2:52this generate automatically button
  70. 2:54that's it a return example will be
  71. 2:56automatically generated this example is
  72. 2:59generated at according to the definition
  73. 3:00of our previous data structure let's
  74. 3:02save it and our API is defined which is
  75. 3:06very simple in one or two minutes you
  76. 3:08can define an API specification the
  77. 3:10process I just demonstrated is
  78. 3:12relatively simple what if my API doesn't
  79. 3:14have a defined data model in that case I
  80. 3:17can add a blank response here and select
  81. 3:19this generate from Json tab just paste
  82. 3:22my Json in and in the preview section
  83. 3:24you will see that a data structure is
  84. 3:27generated automatically press okay to
  85. 3:29save it API doc not only supports Json
  86. 3:31import if we create another blank
  87. 3:33response and go to this generate from
  88. 3:35Json tab once again you will see that it
  89. 3:38also supports XML Jason schema even
  90. 3:41supports directly import from databases
  91. 3:44here you can select a database
  92. 3:45connection and select the database table
  93. 3:48of your choice this way you can import a
  94. 3:50table from the database as data
  95. 3:52structure now if you visit the same tab
  96. 3:55once again and go to manage database
  97. 3:58connection here in the data type you
  98. 4:00will see that API doc supports MySQL
  99. 4:03Oracle click house mongodb red and more
  100. 4:07you can also enter a SQL ddl here to
  101. 4:10generate a data structure finally I can
  102. 4:12also choose to add response component
  103. 4:14from here I can select a referent
  104. 4:16response component such as 400 or 404
  105. 4:20these response components are maintained
  106. 4:22in this component library after you are
  107. 4:24done defining an API just save it now
  108. 4:27some users say that they understand
  109. 4:29understand that creating a API
  110. 4:30documentation is very convenient in API
  111. 4:33doc but our company use Swagger to
  112. 4:35generate API documentation so what
  113. 4:37should they do in that case you can use
  114. 4:39API doc scheduled import function from
  115. 4:41here just go to the import Tab and
  116. 4:43select schedule import from here you can
  117. 4:46press the Swagger URL in and select the
  118. 4:49input frequency like every 3 hour 12
  119. 4:52hours or 24 hours according to un need
  120. 4:54and press save this way you can
  121. 4:56regularly import swager data to API Doc
  122. 4:59and that and use API docs debugging
  123. 5:01documentation Mock and other
  124. 5:05functions okay now we will transition to
  125. 5:08development we will learn how to bring
  126. 5:10the API design to life once the API is
  127. 5:13designed we can start the development
  128. 5:15process however over to this generate
  129. 5:17code option in the API specification we
  130. 5:19Define and you can generate server steps
  131. 5:22and client sdks for the entire project
  132. 5:24this option supports dozens of commonly
  133. 5:27used language such as JavaScript pH P
  134. 5:29nodejs python C++ go and Etc you can
  135. 5:33also configure the coding style from
  136. 5:36here so the back end only needs to add
  137. 5:39the business Logic on the basis of the
  138. 5:41generated code so after writing the code
  139. 5:44we can start smoke testing now let us
  140. 5:46switch to run here you can set the
  141. 5:49parameters and hit send but if your API
  142. 5:52body is a gesson then it might be a
  143. 5:54little complex to put together manually
  144. 5:57now this is where the API docs magic
  145. 5:59happen you can simply click this
  146. 6:00generate automatically button and it
  147. 6:03will appear automatically within seconds
  148. 6:05next let me show you this insert Dynamic
  149. 6:08value feature we can select this name
  150. 6:10and click on insert Dynamic value from
  151. 6:13here we can select the data generator
  152. 6:15option and look for name we'll select
  153. 6:19the full name and press enter now if we
  154. 6:22send this API from the actual request
  155. 6:25section you will notice that every time
  156. 6:28I send it it will will come up with a
  157. 6:30new name so this has now become a
  158. 6:32dynamic value furthermore Dynamic value
  159. 6:35also supports functions like
  160. 6:38md5 Bas 64 substring and many other this
  161. 6:43options makes it very convenient to use
  162. 6:46API do all right this is the phase for
  163. 6:49sending request next we need to look at
  164. 6:51the responses after defining an API is
  165. 6:54crucial to check whether the data
  166. 6:55returned by the API aligns with our
  167. 6:57expectation for example with this API
  168. 7:00let me click Send and you will see that
  169. 7:03in the right corner there is a message
  170. 7:05says that response data differs from the
  171. 7:08API specification now what does this
  172. 7:10mean it's because we have defined the
  173. 7:13response data structure for this API in
  174. 7:15advance so I will automatically have a
  175. 7:17check against the data the backend
  176. 7:19server returns this check verifies if it
  177. 7:22matches the API specification so
  178. 7:25anything that doesn't match the API
  179. 7:27specification will automatically trigger
  180. 7:29and error these minor issues don't need
  181. 7:31to flow into testing we can resolve this
  182. 7:34directly during the backend smoke
  183. 7:36testing which clearly enhance the
  184. 7:38quality of backend code output now let
  185. 7:41me explain another useful feature of API
  186. 7:43do unlike postan where you need to write
  187. 7:46scripts for your pre and post processors
  188. 7:48operation in API doc most of the pre and
  189. 7:51post processor operation can be
  190. 7:53configured visually without scripting
  191. 7:55you can just add Postman syntax from
  192. 7:58this custom script like this and you can
  193. 8:02also reference a public scripts that you
  194. 8:05have written before from here if you
  195. 8:07want you can also add assertation just
  196. 8:10fill in the details here you can also
  197. 8:13extract variables which can transform
  198. 8:16the response of the previous API into
  199. 8:18environment variables what's most
  200. 8:20impressive that API dog also supports
  201. 8:23database operation from here you can
  202. 8:25select the database connections like
  203. 8:28MySQL SQL Oracle mongodb redis and more
  204. 8:33finally after setting up this API
  205. 8:35request simply click save as cases just
  206. 8:38give it a name and press okay once saved
  207. 8:43this will be listed below this API this
  208. 8:46is a unique Concept in API do since all
  209. 8:49operation in API doc revolves around
  210. 8:51apis and an API can have various sets of
  211. 8:54parameters so we recommend saving each
  212. 8:58set of parameters as an API case during
  213. 9:01smoke testing this practice makes
  214. 9:03debugging easier for future sessions and
  215. 9:06allows you to easily reference them in
  216. 9:08testing scenarios during automated
  217. 9:10testing all right we just demonstrated
  218. 9:12API docs design mode we recommend it to
  219. 9:15our most of the users but if your team
  220. 9:17is used to writing the code first then
  221. 9:20design documentation switching to debug
  222. 9:22mode will better switch your
  223. 9:25needs now let me showcase a brief
  224. 9:28demonstration of our smart Mo function
  225. 9:30when the back end is developing the code
  226. 9:32the front end can also enter the
  227. 9:34development process but at this time the
  228. 9:37backend API hasn't been developed so
  229. 9:39what happens when the front end doesn't
  230. 9:41have any data to use in that case they
  231. 9:43can use API doc to generate mock data
  232. 9:45how to do it you will find in this API
  233. 9:48specification there is a mock area with
  234. 9:50mock URL simply copy it and open it in
  235. 9:54your browser paste it here and you can
  236. 9:57see our API data is already already out
  237. 10:00if you refresh it every time the data
  238. 10:02will be different this is a particularly
  239. 10:04useful feature called smart mock as long
  240. 10:07as the API documentation is defined the
  241. 10:09front end can use this data most
  242. 10:11importantly there is no need to do any
  243. 10:13configuration no need to write any
  244. 10:14scripts and the generated mock data is
  245. 10:17very user friendly now if you need a
  246. 10:19fixed return you can go to this edit
  247. 10:21option and from here go to this mock
  248. 10:24area and you can just directly select
  249. 10:26one or write in it this place also
  250. 10:29support customization then you can just
  251. 10:31save it and refresh it here and the mock
  252. 10:34data will come out as the way you want
  253. 10:36it to be AP do Mo function is very rich
  254. 10:39in the advanced mock option you will
  255. 10:41find expectation scripts and many other
  256. 10:44Rich functions it also supports the
  257. 10:46cloud
  258. 10:48Moog okay next we will explore automated
  259. 10:51testing following the demo we will dive
  260. 10:53into an insightful overview of our
  261. 10:55automated testing capabilities AP do
  262. 10:57automated testing capabilities has
  263. 10:59undergone an epic progress in recent
  264. 11:01days let me share briefly in API doc if
  265. 11:03you want to run multiple apis together
  266. 11:06all you need to do is switch to this
  267. 11:08testing module first we create a new
  268. 11:10test scenario from here let's name it
  269. 11:13and save and then I can go to this add
  270. 11:16step option and choose to import from
  271. 11:19API cases here just select the API cases
  272. 11:22I want to run and add now if I want I
  273. 11:26can also rearrange the order next I need
  274. 11:29to select an environment from here and
  275. 11:31click on run that's it a test will be
  276. 11:34generated within seconds here's the test
  277. 11:37report indicating that if each API
  278. 11:39selected either passed or failed if it's
  279. 11:41failed you can click on here to see the
  280. 11:44reason click on more to see the details
  281. 11:46which is very convenient for locating
  282. 11:48the problem and you can also share this
  283. 11:51report with your colleagues to
  284. 11:52collaborate together now if we get back
  285. 11:55then for more complex test scenarios we
  286. 11:57can also use this function function like
  287. 11:59grouping Loops cost referencing from
  288. 12:02other test scenarios and more let's add
  289. 12:05a weight condition here and change the
  290. 12:07order now if we run it the test process
  291. 12:11will wait for 1,000 millisecond after
  292. 12:14execution before executing the next step
  293. 12:16moreover we often have multiple test
  294. 12:19scenarios and during regression testing
  295. 12:22we need to run the entire process at
  296. 12:24once in that case I can click on this
  297. 12:26root directory level and from this all
  298. 12:28scenario option I can select all the
  299. 12:30test scenarios and batch run them
  300. 12:33together this is very convenient and I
  301. 12:35can just do it with one click now if we
  302. 12:38get back to our API here you can switch
  303. 12:40to cicd option and select an environment
  304. 12:43from here and just save it this will
  305. 12:46generate a commands automatically now
  306. 12:49you can integrate them into Jenkins or
  307. 12:51use api. CLI to run
  308. 12:54them after the API development and
  309. 12:57testing are complete it can be released
  310. 12:59for the other teams to use we can easily
  311. 13:01generate an API documentation from this
  312. 13:04share tab just click on new and select
  313. 13:07the title then select an environment
  314. 13:10from here now from this option you can
  315. 13:13select to share all the apis or manually
  316. 13:16select the one you want and press okay
  317. 13:20you can also add a password select the
  318. 13:23language and save after we save it you
  319. 13:26will get a link just copy this link and
  320. 13:29open it in your
  321. 13:30browser and you will find your
  322. 13:32comprehensive API documentation here
  323. 13:34each API request will have the request
  324. 13:37parameter response data and more but
  325. 13:40that's not all you can also try it out
  326. 13:42directly on this page where you can send
  327. 13:45the request with a single click
  328. 13:47additionally it also supports request
  329. 13:49samples in many
  330. 13:51languages if I want I can also generate
  331. 13:54a code from here this options makes it
  332. 13:57very convenient to call this API finally
  333. 14:00I would like to show that our API
  334. 14:02documentation also support customization
  335. 14:04from this options you can customize the
  336. 14:07navigation bars domain names and SEO
  337. 14:10setting and many
  338. 14:13other lastly the API data maintained by
  339. 14:15API dog can easily be exported from here
  340. 14:18in open API specification HTML markdown
  341. 14:22and API DOC format also if you have a
  342. 14:25complete API project from this import
  343. 14:27data option you can import the data from
  344. 14:30open API Swagger Postman insomnia and
  345. 14:34many other platform this way you can
  346. 14:36quickly migrate the existing projects
  347. 14:38from other platforms to API do now if
  348. 14:42you're using a GPC architecture you can
  349. 14:44navigate to the homepage and from here
  350. 14:46create a new project to select the drpc
  351. 14:49project type and easily test the
  352. 14:51corresponding API also from here you can
  353. 14:55invite the members select the plans
  354. 14:58check all activities of Team projects
  355. 15:00and members and also change the setting
  356. 15:03finally I would like to add that API dog
  357. 15:06has recently launched iterative branches
  358. 15:09and performance testing if you need to
  359. 15:11use them please continue to follow API
  360. 15:13dos change lock and health
  361. 15:15documentation okay this wraps up the
  362. 15:17core workflow of API doc covering API
  363. 15:20design documentation debugging mocking
  364. 15:23and automated testing thank you for your
  365. 15:26time and attention

About this transcript

This page contains the full transcript of How to Use Apidog | All-in-one Collaborative API Development Platform by Apidog, generated from the public captions YouTube serves with the video. The transcript has 2,516 words across 365 segments, with the original timestamps preserved so you can click any line to jump to that moment in the embedded player.

What you can do with it

Use the transcript to take notes, quote the speaker, build a study guide, generate a summary with ChatGPT or Claude via the YouTube Summary tool, or export it as a timed subtitle file with YouTube to SRT. You can also re-open it in the transcriber to choose a caption track available on the video.

Free YouTube transcript tool

YouTube2Text is a free YouTube transcript generator — no signup, no daily limit. Paste any YouTube link and get the full transcript instantly, with timestamps, click-to-jump, caption language selection, AI prompts for ChatGPT, Claude, and Gemini, and exports to TXT, SRT, VTT, or Markdown.