https://github.com/cpollet/postman-maven-plugin

A maven plugin to export JAX-RS annotated classes and methods to Postman collection
https://github.com/cpollet/postman-maven-plugin

maven-plugin postman postman-collection

Last synced: 3 months ago
JSON representation

A maven plugin to export JAX-RS annotated classes and methods to Postman collection

• Host: GitHub
• URL: https://github.com/cpollet/postman-maven-plugin
• Owner: cpollet
• License: apache-2.0
• Created: 2018-06-01T19:33:18.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T14:54:57.000Z (about 1 year ago)
• Last Synced: 2024-09-29T18:23:11.649Z (3 months ago)
• Topics: maven-plugin, postman, postman-collection
• Language: Java
• Homepage:
• Size: 119 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: changes.xml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/cpollet/postman-maven-plugin.svg?branch=master)](https://travis-ci.org/cpollet/postman-maven-plugin)

[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=net.cpollet.maven.plugins%3Apostman-maven-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=net.cpollet.maven.plugins%3Apostman-maven-plugin)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.cpollet.maven.plugins/postman-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.cpollet.maven.plugins/postman-maven-plugin)

# Postman Maven Plugin

A maven plugin to export [JAX-RS](https://github.com/jax-rs) annotated classes and methods to [Postman collection](https://www.getpostman.com/collection).

# Usage

Requirements

* Java 8+

* Maven 3.5.0+

## CLI

In you ```~/.m2/settings.xml``` file, add the following:

```

  net.cpollet.maven.plugins

```

Then, to generates a file ```${project.artifactId}-${project.version}.json``` containing the postman collection in the ```target``` folder:

```

$ mvn postman:generate -Dpostman.packagesToScan=net.cpollet \

                       -Dpostman.baseUrl=http://localhost \

                       -Dpostman.basicAuth.username=username \

                       -Dpostman.basicAuth.password=password

```

You can execute this command from the ```jaxrs``` folder for instance.

* ```postman.baseUrl``` mandatory. A valid URL that will be used as the base URL for all discovered endpoints;

* ```postman.packagesToScan``` optional. If not set, the plugin will scan all packages;

* ```postman.basicAuth.*``` optional.

## pom.xml

The CLI equivalent XML configuration is:

```

    net.cpollet.maven.plugins

    postman-maven-plugin

    ...

    

         

            net.cpollet

            

        

        

            

                default

                http://localhost

                 

                    username

                    password

                

            

            

        

    

     

        

            generate-postman

            package

            

                generate

            

        

    

```

The `````` section is optional, as the plugin binds it's ```generate``` goal to the ```package``` phase. 

# Build

```

$ mvn clean install

```

Tu run the integration tests, use the ```run-its``` profile. Make sure you have the ```newman-assert``` and ```rodolpheche/wiremock``` docker images:

```

$ cd newman-assert && build.sh && cd ..

$ docker pull rodolpheche/wiremock

```

Then:

```

$ mvn clean install -Prun-its 

```

# Release & Deploy

When ```gpg: signing failed: Inappropriate ioctl for device```, executing ```export GPG_TTY=$(tty)``` might help.

## Validating before tagging

To validate the checks sonatype executes before tagging, update the ```pom.xml``` to remove the ```-SNAPSHOT```. Then, execute

```

$ mvn clean deploy -Prelease

```

## Actual release

```

$ mvn clean release:clean release:prepare

$ mvn release:perform

```

Release from web UI