A reference is presented in three formats for each unit: The References section has resources for the different properties of a collection unit. It covers every part of a request, how to save responses, working with events, variables, and more. This Concepts section delves deeply into the different aspects of a collection and how to work with them. This section helps you quickly understand what a collection is, how it is structured on a high level, and how to model a simple API request in a collection. The Getting Started section introduces you to the most basic form of a collection and how it can be used to model very simple APIs. Multiple references: A reference section includes an image, table, and schema reference of different units of a collection.įor easing viewing, the documentation has been divided into the following sections: Getting Started.Comparison with collections in Postman: The documentation consistently compares how a collection is represented in the spec and how it is represented in Postman it has an entire section highlighting these differences.A walk-through, not a reference: The new documentation walks you through the different units of a collection and how to author your own collection definition, starting from the most basic form of an API.Better SEO: The new documentation is hosted on the Learning Center and has an improved SEO, which makes its resources more visible on a web search.New look and feel: The documentation now has a new look and feel inspired by the Postman Learning Center’s flow and structure.We’re excited to share that learning about the collection format just got a lot easier with Postman’s new and revamped documentation. Each unit has several deeply nested nodes that may be endlessly traversed, which does not give you the best experience possible. This documentation has a reference-based approach to explaining different units of a collection. Previously, the only resource available for learning about the format was the auto-generated documentation hosted on. The collection format is the specification that drives Postman Collections, and it provides a unique way of organizing API requests and modeling API workflows. Related: Use the API Documentation Template The first thing that most likely comes to your mind is an API request or a group of API requests and how they are run and organized. When you think about Postman Collections, the first thing that often comes to your mind isn’t a JSON-based API specification.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |