This type of documentation also describesin plain languagewhat each endpoint is intended to do. Next we will create a collection by clicking on “New Collection” in the left column of the Postman panel. We need to name the collection and here we have named it as ‘ Project 1.’ We can optionally specify a description for the collection by selecting the documentation icon and then using the edit icon to write the description. Four of the most common types are: Reference documentation: Reference documentation typically provides a rundown of every endpoint, including its methods, parameters, and accepted data types. Let us start by first logging into the Postman application.Ģ. Initially we have to create a collection folder that stores all the API endpoints that we want in our documentation. The collection folder allows you to group a particular set of requests related to an API and you can go on adding new requests with similar endpoints.ġ. It will document step-wise process and instructions as to how the API should be used as well as the status codes, error codes, content types while offering specific examples as to how to use them.Ĭreating documentation with Postman will also enable us to get a public or private URL for our API documentation.Ĭreating API documentation with Postman is easy, fast, and can be achieved with just a few clicks. The instruction manual will lists a bunch of operations that developers can use and can be in the form of tutorials, code examples, screenshots, and anything else to enable them to understand the usage of the API easily. The responses can be saved for later use and converted to code for different languages such as Javascript, Python, Php, Ruby, etc.Īnother great feature of Postman is that it has an easy to use documentation methodology that can be used to generate well structured instruction manual that provides developers or other third-party users to use the API efficiently. Postman acts as an HTTP client that tests HTTP requests, using a graphical user interface, through which we obtain different types of responses that need to be subsequently validated. API stands for Application Programming Interface and acts as a software intermediary where two applications can communicate and exchange data with each other using a set of definitions and protocols. Postman is a great scalable and development tool that can be used for API testing.
0 Comments
Leave a Reply. |