https://github.com/wolfpack-digital/apipie-postman

Ruby gem to generate Postman collection from Apipie output.
https://github.com/wolfpack-digital/apipie-postman

apipie hacktoberfest postman rails rspec ruby ruby-gem

Last synced: 15 days ago
JSON representation

Ruby gem to generate Postman collection from Apipie output.

• Host: GitHub
• URL: https://github.com/wolfpack-digital/apipie-postman
• Owner: Wolfpack-Digital
• License: mit
• Created: 2021-08-16T13:52:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T01:35:32.000Z (4 months ago)
• Last Synced: 2024-10-29T14:17:59.597Z (18 days ago)
• Topics: apipie, hacktoberfest, postman, rails, rspec, ruby, ruby-gem
• Language: Ruby
• Homepage:
• Size: 31.3 KB
• Stars: 18
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# apipie-postman [![Gem Version](https://badge.fury.io/rb/apipie-postman.svg)](https://badge.fury.io/rb/apipie-postman)

## Description

`apipie-postman` is a Ruby gem that automatically generates a Postman collection based on your apipie json output.

The main reason we built this was because we were often in need for a Postman collection with the APIs we designed, but the work seemed to be duplicate. Also, the collection is hard to maintain and many times left incomplete.

## Installation

* find the gem on https://rubygems.org/gems/apipie-postman

* add the gem in `group :development, :test`

* generate a Postman API key; details [here](https://learning.postman.com/docs/developer/intro-api/)

* add an initializer file to `config/initializers/apipie_postman.rb`:

```ruby

ApipiePostman.configure do |config|

  config.postman_api_key = 'your_postman_api_key'

  config.postman_collection_name = 'Your collection name'

  config.base_url = 'localhost:3000' # the base_url that you want in your postman collection

end

```

* run `bundle exec apipie-postman`

## Usage

* running `bundle exec apipie-postman` will create the apipie_postman.rake file

* run `bundle exec rake apipie_postman` to run the task and generate docs

## Testing

The gem uses [Rspec](https://rubygems.org/gems/rspec) for testing. In order to make sure all tests are running, run `bundle install` and `bundle exec rspec spec/file_to_test.rb` or `bundle exec rspec spec/*` (to run all files).

## Want to contribute?

![](https://img.shields.io/github/issues/VictorMotogna/apipie-postman?style=flat-square)\

Check out [`CONTRIBUTING.md`](CONTRIBUTING.md).