Skip to content

Dmitiry1921/postman2apiary

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

Install

npm i postman2apiary

Using

const postman2apiary = require('postman2apiary');

try {
    postman2apiary(YourAPIKey, collectionID, APIBaseURL, './apiary.apib');
}catch (err) {
    console.log({err, message:"Ошибка при попытке создать кокументацию"});
}

postman2apiary(PostmanAPIkey, collectionID, apiURL, outputPath)

Функция создающая докумнтацию из POSTMAN Collection

Kind: global function

Param Type Default Description
PostmanAPIkey String API KEY Postman
collectionID String Название коллекции которую собходимо экспортировать можно узнать при экспорте коллекции постмен
apiURL String базовый url вашего API
outputPath String ./apiary.apib путь в котором следует сохранить конечный файл

About

Parse Postman collection to blueprint documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published