Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/postmanlabs/collection-format-docs

Documentation for postman collection format, the open source specification that powers collections in postman
https://github.com/postmanlabs/collection-format-docs

collection-format collection-tooling collections postman postman-collection

Last synced: 3 months ago
JSON representation

Documentation for postman collection format, the open source specification that powers collections in postman

Awesome Lists containing this project

README

        

![Postman logo](https://assets.getpostman.com/common-share/postman-github-logo.png "Postman logo")

# Postman Collection Format

The collection format is the specification behind [Postman Collections](https://www.postman.com/collection/), it lets you model API workflows and organize requests. The documentation helps you understand the format, how it relates to collections in Postman and the different toolings that have been built around the format both by Postman and it's developer community.

## Contribution guidelines

We would love for you to contribute to the Collection Format Docs! To contribute to this project, please read:

- The [Code of Conduct](https://www.postman.com/code-of-conduct)
- The [Contribution Guidelines](https://github.com/postmanlabs/collection-format-docs/blob/develop/CONTRIBUTING.md)
- The [Documentation Style Guide](https://github.com/postmanlabs/collection-format-docs/blob/develop/DOCS_STYLE_GUIDE.md)

## Tech stack

The Docs are built using ReactJS, GatsbyJS Framework, and styled components for styling.

## How to get started

```
$ git clone https://github.com/postmanlabs/collection-format-docs
$ collection-format-docs
$ npm run nvmrc
$ nvm use
$ npm install
$ npm install -g gatsby-cli
$ npm run dev
```

## License

[Apache License 2.0](https://github.com/postmanlabs/collection-format-docs/blob/develop/LICENSE)