How to Use Apidog | All-in-one Collaborative API Development Platform — Transcript
Full transcript
- 0:00hi welcome to API do your all-in-one
- 0:03collaborative API development platform
- 0:05this video is designed for those who are
- 0:07new to API Doc and I will walk you
- 0:10through a core functions to ensure you
- 0:12quickly craft the key features of API do
- 0:16so we will start by exploring how to
- 0:18make an API call then move on to
- 0:21designing and developing apis after that
- 0:23we will explore API do smart mock
- 0:26function and finally we will conclude
- 0:28the tutorial with an overview of API
- 0:30docs automated testing and API
- 0:32documentation so without further Ado
- 0:35let's get
- 0:37started after completing the signup
- 0:39process when you open API Dog app you
- 0:41will find yourself on this interface now
- 0:44to make an API call Select new request
- 0:47then just paste your URL in and click
- 0:50Send now if the API request runs
- 0:53smoothly all you have to do is click
- 0:56here and select save as API just give it
- 0:59a name and save that's it API dog will
- 1:03automatically create an API
- 1:04specification for you covering the path
- 1:07parameters responses and examples
- 1:09creating an API specification in API Doc
- 1:12is as easy as that it is recommended to
- 1:15save the request as an API because API
- 1:18Doc is more than just a platform for
- 1:21sending API request it's a comprehensive
- 1:24API development platform designed with
- 1:26API design first approach in
- 1:28mind
- 1:30okay moving forward we will explore how
- 1:33to design an API at API doc we
- 1:35recommends API design first approach
- 1:37just now I demonstrated how to call an
- 1:39API I will now create a new API from
- 1:42scratch to do that let's select new API
- 1:45and enter pet slid okay and you can see
- 1:49here the path parameters are
- 1:50automatically detected later the name
- 1:53like demo status tags and description
- 1:57can be filled in very easily then we can
- 1:59start start defining our API generally
- 2:02most of the companies will have common
- 2:03data structure like code message and
- 2:06data you can see that my API
- 2:08automatically has it if you are
- 2:10wondering why is that because API do
- 2:12provides a very useful feature called
- 2:14default response template as long as the
- 2:17template is set the new API in your
- 2:19project will automatically have it now
- 2:21you may ask the data of each API
- 2:24probably going to be different but to do
- 2:26that you can click here and select
- 2:28schema reference then select a sample
- 2:31schema like pet so while defining our
- 2:35API we can easily refer to some of the
- 2:37commonly used data structure in our API
- 2:39all you need to do is pre- them in this
- 2:42schema section so that we can reference
- 2:44them in the API now in the example
- 2:47section let's click add example and
- 2:50select success case and then just hit
- 2:52this generate automatically button
- 2:54that's it a return example will be
- 2:56automatically generated this example is
- 2:59generated at according to the definition
- 3:00of our previous data structure let's
- 3:02save it and our API is defined which is
- 3:06very simple in one or two minutes you
- 3:08can define an API specification the
- 3:10process I just demonstrated is
- 3:12relatively simple what if my API doesn't
- 3:14have a defined data model in that case I
- 3:17can add a blank response here and select
- 3:19this generate from Json tab just paste
- 3:22my Json in and in the preview section
- 3:24you will see that a data structure is
- 3:27generated automatically press okay to
- 3:29save it API doc not only supports Json
- 3:31import if we create another blank
- 3:33response and go to this generate from
- 3:35Json tab once again you will see that it
- 3:38also supports XML Jason schema even
- 3:41supports directly import from databases
- 3:44here you can select a database
- 3:45connection and select the database table
- 3:48of your choice this way you can import a
- 3:50table from the database as data
- 3:52structure now if you visit the same tab
- 3:55once again and go to manage database
- 3:58connection here in the data type you
- 4:00will see that API doc supports MySQL
- 4:03Oracle click house mongodb red and more
- 4:07you can also enter a SQL ddl here to
- 4:10generate a data structure finally I can
- 4:12also choose to add response component
- 4:14from here I can select a referent
- 4:16response component such as 400 or 404
- 4:20these response components are maintained
- 4:22in this component library after you are
- 4:24done defining an API just save it now
- 4:27some users say that they understand
- 4:29understand that creating a API
- 4:30documentation is very convenient in API
- 4:33doc but our company use Swagger to
- 4:35generate API documentation so what
- 4:37should they do in that case you can use
- 4:39API doc scheduled import function from
- 4:41here just go to the import Tab and
- 4:43select schedule import from here you can
- 4:46press the Swagger URL in and select the
- 4:49input frequency like every 3 hour 12
- 4:52hours or 24 hours according to un need
- 4:54and press save this way you can
- 4:56regularly import swager data to API Doc
- 4:59and that and use API docs debugging
- 5:01documentation Mock and other
- 5:05functions okay now we will transition to
- 5:08development we will learn how to bring
- 5:10the API design to life once the API is
- 5:13designed we can start the development
- 5:15process however over to this generate
- 5:17code option in the API specification we
- 5:19Define and you can generate server steps
- 5:22and client sdks for the entire project
- 5:24this option supports dozens of commonly
- 5:27used language such as JavaScript pH P
- 5:29nodejs python C++ go and Etc you can
- 5:33also configure the coding style from
- 5:36here so the back end only needs to add
- 5:39the business Logic on the basis of the
- 5:41generated code so after writing the code
- 5:44we can start smoke testing now let us
- 5:46switch to run here you can set the
- 5:49parameters and hit send but if your API
- 5:52body is a gesson then it might be a
- 5:54little complex to put together manually
- 5:57now this is where the API docs magic
- 5:59happen you can simply click this
- 6:00generate automatically button and it
- 6:03will appear automatically within seconds
- 6:05next let me show you this insert Dynamic
- 6:08value feature we can select this name
- 6:10and click on insert Dynamic value from
- 6:13here we can select the data generator
- 6:15option and look for name we'll select
- 6:19the full name and press enter now if we
- 6:22send this API from the actual request
- 6:25section you will notice that every time
- 6:28I send it it will will come up with a
- 6:30new name so this has now become a
- 6:32dynamic value furthermore Dynamic value
- 6:35also supports functions like
- 6:38md5 Bas 64 substring and many other this
- 6:43options makes it very convenient to use
- 6:46API do all right this is the phase for
- 6:49sending request next we need to look at
- 6:51the responses after defining an API is
- 6:54crucial to check whether the data
- 6:55returned by the API aligns with our
- 6:57expectation for example with this API
- 7:00let me click Send and you will see that
- 7:03in the right corner there is a message
- 7:05says that response data differs from the
- 7:08API specification now what does this
- 7:10mean it's because we have defined the
- 7:13response data structure for this API in
- 7:15advance so I will automatically have a
- 7:17check against the data the backend
- 7:19server returns this check verifies if it
- 7:22matches the API specification so
- 7:25anything that doesn't match the API
- 7:27specification will automatically trigger
- 7:29and error these minor issues don't need
- 7:31to flow into testing we can resolve this
- 7:34directly during the backend smoke
- 7:36testing which clearly enhance the
- 7:38quality of backend code output now let
- 7:41me explain another useful feature of API
- 7:43do unlike postan where you need to write
- 7:46scripts for your pre and post processors
- 7:48operation in API doc most of the pre and
- 7:51post processor operation can be
- 7:53configured visually without scripting
- 7:55you can just add Postman syntax from
- 7:58this custom script like this and you can
- 8:02also reference a public scripts that you
- 8:05have written before from here if you
- 8:07want you can also add assertation just
- 8:10fill in the details here you can also
- 8:13extract variables which can transform
- 8:16the response of the previous API into
- 8:18environment variables what's most
- 8:20impressive that API dog also supports
- 8:23database operation from here you can
- 8:25select the database connections like
- 8:28MySQL SQL Oracle mongodb redis and more
- 8:33finally after setting up this API
- 8:35request simply click save as cases just
- 8:38give it a name and press okay once saved
- 8:43this will be listed below this API this
- 8:46is a unique Concept in API do since all
- 8:49operation in API doc revolves around
- 8:51apis and an API can have various sets of
- 8:54parameters so we recommend saving each
- 8:58set of parameters as an API case during
- 9:01smoke testing this practice makes
- 9:03debugging easier for future sessions and
- 9:06allows you to easily reference them in
- 9:08testing scenarios during automated
- 9:10testing all right we just demonstrated
- 9:12API docs design mode we recommend it to
- 9:15our most of the users but if your team
- 9:17is used to writing the code first then
- 9:20design documentation switching to debug
- 9:22mode will better switch your
- 9:25needs now let me showcase a brief
- 9:28demonstration of our smart Mo function
- 9:30when the back end is developing the code
- 9:32the front end can also enter the
- 9:34development process but at this time the
- 9:37backend API hasn't been developed so
- 9:39what happens when the front end doesn't
- 9:41have any data to use in that case they
- 9:43can use API doc to generate mock data
- 9:45how to do it you will find in this API
- 9:48specification there is a mock area with
- 9:50mock URL simply copy it and open it in
- 9:54your browser paste it here and you can
- 9:57see our API data is already already out
- 10:00if you refresh it every time the data
- 10:02will be different this is a particularly
- 10:04useful feature called smart mock as long
- 10:07as the API documentation is defined the
- 10:09front end can use this data most
- 10:11importantly there is no need to do any
- 10:13configuration no need to write any
- 10:14scripts and the generated mock data is
- 10:17very user friendly now if you need a
- 10:19fixed return you can go to this edit
- 10:21option and from here go to this mock
- 10:24area and you can just directly select
- 10:26one or write in it this place also
- 10:29support customization then you can just
- 10:31save it and refresh it here and the mock
- 10:34data will come out as the way you want
- 10:36it to be AP do Mo function is very rich
- 10:39in the advanced mock option you will
- 10:41find expectation scripts and many other
- 10:44Rich functions it also supports the
- 10:46cloud
- 10:48Moog okay next we will explore automated
- 10:51testing following the demo we will dive
- 10:53into an insightful overview of our
- 10:55automated testing capabilities AP do
- 10:57automated testing capabilities has
- 10:59undergone an epic progress in recent
- 11:01days let me share briefly in API doc if
- 11:03you want to run multiple apis together
- 11:06all you need to do is switch to this
- 11:08testing module first we create a new
- 11:10test scenario from here let's name it
- 11:13and save and then I can go to this add
- 11:16step option and choose to import from
- 11:19API cases here just select the API cases
- 11:22I want to run and add now if I want I
- 11:26can also rearrange the order next I need
- 11:29to select an environment from here and
- 11:31click on run that's it a test will be
- 11:34generated within seconds here's the test
- 11:37report indicating that if each API
- 11:39selected either passed or failed if it's
- 11:41failed you can click on here to see the
- 11:44reason click on more to see the details
- 11:46which is very convenient for locating
- 11:48the problem and you can also share this
- 11:51report with your colleagues to
- 11:52collaborate together now if we get back
- 11:55then for more complex test scenarios we
- 11:57can also use this function function like
- 11:59grouping Loops cost referencing from
- 12:02other test scenarios and more let's add
- 12:05a weight condition here and change the
- 12:07order now if we run it the test process
- 12:11will wait for 1,000 millisecond after
- 12:14execution before executing the next step
- 12:16moreover we often have multiple test
- 12:19scenarios and during regression testing
- 12:22we need to run the entire process at
- 12:24once in that case I can click on this
- 12:26root directory level and from this all
- 12:28scenario option I can select all the
- 12:30test scenarios and batch run them
- 12:33together this is very convenient and I
- 12:35can just do it with one click now if we
- 12:38get back to our API here you can switch
- 12:40to cicd option and select an environment
- 12:43from here and just save it this will
- 12:46generate a commands automatically now
- 12:49you can integrate them into Jenkins or
- 12:51use api. CLI to run
- 12:54them after the API development and
- 12:57testing are complete it can be released
- 12:59for the other teams to use we can easily
- 13:01generate an API documentation from this
- 13:04share tab just click on new and select
- 13:07the title then select an environment
- 13:10from here now from this option you can
- 13:13select to share all the apis or manually
- 13:16select the one you want and press okay
- 13:20you can also add a password select the
- 13:23language and save after we save it you
- 13:26will get a link just copy this link and
- 13:29open it in your
- 13:30browser and you will find your
- 13:32comprehensive API documentation here
- 13:34each API request will have the request
- 13:37parameter response data and more but
- 13:40that's not all you can also try it out
- 13:42directly on this page where you can send
- 13:45the request with a single click
- 13:47additionally it also supports request
- 13:49samples in many
- 13:51languages if I want I can also generate
- 13:54a code from here this options makes it
- 13:57very convenient to call this API finally
- 14:00I would like to show that our API
- 14:02documentation also support customization
- 14:04from this options you can customize the
- 14:07navigation bars domain names and SEO
- 14:10setting and many
- 14:13other lastly the API data maintained by
- 14:15API dog can easily be exported from here
- 14:18in open API specification HTML markdown
- 14:22and API DOC format also if you have a
- 14:25complete API project from this import
- 14:27data option you can import the data from
- 14:30open API Swagger Postman insomnia and
- 14:34many other platform this way you can
- 14:36quickly migrate the existing projects
- 14:38from other platforms to API do now if
- 14:42you're using a GPC architecture you can
- 14:44navigate to the homepage and from here
- 14:46create a new project to select the drpc
- 14:49project type and easily test the
- 14:51corresponding API also from here you can
- 14:55invite the members select the plans
- 14:58check all activities of Team projects
- 15:00and members and also change the setting
- 15:03finally I would like to add that API dog
- 15:06has recently launched iterative branches
- 15:09and performance testing if you need to
- 15:11use them please continue to follow API
- 15:13dos change lock and health
- 15:15documentation okay this wraps up the
- 15:17core workflow of API doc covering API
- 15:20design documentation debugging mocking
- 15:23and automated testing thank you for your
- 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.