Skip to content
This repository has been archived by the owner on Dec 27, 2024. It is now read-only.

Commit

Permalink
docs: first structure
Browse files Browse the repository at this point in the history
  • Loading branch information
joolfe committed Jul 29, 2020
1 parent 60ef3cd commit 505a03c
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,21 @@

[![build](https://img.shields.io/github/workflow/status/joolfe/postman-util-lib/Node%20CI?&label=Build&logo=github&style=flat-square)](https://github.com/joolfe/postman-util-lib/actions)
[![codecov](https://img.shields.io/codecov/c/github/joolfe/postman-util-lib?logo=codecov&style=flat-square)](https://codecov.io/gh/joolfe/postman-util-lib)
![build](https://img.shields.io/badge/Postman-%3E=7.0.9-green?logo=postman&style=flat-square&color=FF6C37)

## Features

- Postman Collection v2.1
- OpenApi 3.0
- POST request with JSON body.
- Allow extract the api version from a collection general `variable`.
- Basic method conversion (GET, POST, PUT...)
- Customize general API information.
- Transform query and headers parameters.
- Extract the api version from a collection general `variable`.
- Transform query, headers and path parameters.
- Postman variables in as Path parameters.
- Automatic infer types from query and headers parameters.
- Support Json and Text body formats.
- Global Authentication and Authorization parse
- Basic
- Bearer
- Global Authentication and Authorization by configuration
- Global Authentication and Authorization parse (Basic and Bearer).
- Global Authentication and Authorization by configuration.
- Support Postman folders as tags.

</div></div>
<div class="tilted-section"><div markdown="1">
Expand All @@ -31,18 +30,30 @@
```
npm i postman-to-openapi --save
```
To use as CLI coming soon...

To use as a cli coming soon...

</div></div>
<div class="tilted-section"><div markdown="1">

# Usage

```
const postmanToOpenApi = require('postman-to-openapi')
const result = await postmanToOpenApi('./path/to/postman/collection.json', './api/collection.yml', { save: true })
```

## Options

</div></div>
<div class="tilted-section"><div markdown="1">

# Postman collection
# Features

</div></div>
<div class="tilted-section"><div markdown="1">

# Postman collections

</div></div>

0 comments on commit 505a03c

Please sign in to comment.