Idiomas da documentação

Português

English

Portugês

Projeto base do pacote: postman-to-openapi

🛸 Conversor Postman Collection v2.1/v2.0 para OpenAPI v3.0.

Em resumo, transforme o formato PostmanCollection_v2.1.json ou o formato PostmanCollection_v2.0.json para o formato OpenAPI 3.0

Instalação

Usando npm

npm i postman-to-openapi

Usando yarn

yarn add postman-to-openapi

Para instalar como um cli apenas

npm i postman-to-openapi -g

Utilizando o conversor

Como uma biblioteca

// Require Package
const postmanToOpenApi = require('postman-to-openapi')

// Postman Collection
const postmanCollection = require('./path/to/postman/collection.json')

// Output OpenAPI Path (recurso desativado temporariamente)
// const outputFile = './api/collection.yml'
const outputFile = null

// Async/await
try {
    const result = await postmanToOpenApi(postmanCollection, outputFile, { defaultTag: 'General' })

    console.log(`OpenAPI specs: ${result}`)

    return result

} catch (err) {
    console.log(err)
}

// Promise callback style
const result = postmanToOpenApi(postmanCollection, outputFile, { defaultTag: 'General' })
    .then(result => {
      console.log(`OpenAPI specs: ${result}`)

      return result
    })
    .catch(err => {
      console.log(err)
    })

Por bash / cli

p2o ./path/to/PostmantoCollection.json -f ./path/to/result.yml -o ./path/to/options.json

Exemplo Cli

Documentação

Todos os recursos, instruções de uso e ajuda podem ser encontrados na página da documentação (em inglês).

Ambiente

Para executar este projeto são necessários:

• Node.js v10.15.3 ou acima
• Seguir as regras de padronização de código Standard JS.
• Testes com mocha.js.

Execute os scripts do package.json:

• test:unit: Execute os teste unitários (mocha).
• test: Execute nyc npm run test:unit-no-only.
• lint: Execute os testes de padronização de códigos (standard lint) para buscar erros nos códigos.
• lint:fix: Execute o standard lint e corrija os erros automaticamente.
• changelog: Atualize o changelog automaticamente.

Passos para gerar o GIF demo:

• Instale terminalizer: npm install -g terminalizer
• Inicie uma gravação, usando: terminalizer record demo -d 'zsh'
• Pare a gravação com Ctrl+D
• Verifique a gravação com: terminalizer play demo
• Ajuste os delays no demo.yml, modifique rows para 15 (o valor mais alto) e torne a sessão do terminal anônima.
• Crie o gif com: terminalizer render demo

Husky está configurado para impedir o envio de conteúdo incorreto para o repositório.

Tags

Nodejs Javascript OpenAPI Postman Newman Collection Transform Convert

Licença

Acesse o arquivo LICENÇA.

English

Package made from: postman-to-openapi

🛸 Convert Postman Collection v2.1/v2.0 to OpenAPI v3.0.

Or in other words, transform this specification and also this to this one

Installation

Using npm:

npm i postman-to-openapi

Using yarn:

yarn add postman-to-openapi

To install as a cli just

npm i postman-to-openapi -g

Quick Usage

As a library

// Require Package
const postmanToOpenApi = require('postman-to-openapi')

// Postman Collection Path
const postmanCollection = './path/to/postman/collection.json'
// Output OpenAPI Path
const outputFile = './api/collection.yml'

// Async/await
try {
    const result = await postmanToOpenApi(postmanCollection, outputFile, { defaultTag: 'General' })
    // Without save the result in a file
    const result2 = await postmanToOpenApi(postmanCollection, null, { defaultTag: 'General' })
    console.log(`OpenAPI specs: ${result}`)
} catch (err) {
    console.log(err)
}

// Promise callback style
postmanToOpenApi(postmanCollection, outputFile, { defaultTag: 'General' })
    .then(result => {
        console.log(`OpenAPI specs: ${result}`)
    })
    .catch(err => {
        console.log(err)
    })

As a cli

p2o ./path/to/PostmantoCollection.json -f ./path/to/result.yml -o ./path/to/options.json

Cli Demo

Documentation

All features, usage instructions and help can be found in the Documentation page

Development

This project use for development:

• Node.js v10.15.3 or higher
• Standard JS rules to maintain clean code.
• Use Conventional Commit for commit messages.
• Test with mocha.js.

Use the scripts in package.json:

• test:unit: Run mocha unit test.
• test: Execute test:lint plus code coverage.
• lint: Execute standard lint to review errors in code.
• lint:fix: Execute standard lint and automatically fix errors.
• changelog: Update changelog automatically.

Steps to generate the gif demo:

• Install terminalizer npm install -g terminalizer
• Start a recording using terminalizer record demo -d 'zsh'
• Stop recording with Ctrl+D
• Check demo with terminalizer play demo
• Adjust delays in demo.yml, change rows to 15 (is the height) and anonymize terminal session.
• Generate the gif with terminalizer render demo

Husky is configured to avoid push incorrect content to git.

Tags

Nodejs Javascript OpenAPI Postman Newman Collection Transform Convert

License

See the LICENSE file.