ericfan / chocotea

A library that generates postman collection and integration tests from java code

ChocoTea ☕️

⭐ Star on GitHub — it motivates a lot!

Chocotea is a library that generates postman collection, environment and integration tests from java code.

The aim of chocotea is to help reduce the amount of time it takes to setup a postman collection with requests and tests manually. It also helps with sharing API codebase(s), new developers can generate a postman collection for their changes.

Chocotea runs at compile, generates collection json file and works with:

• Spring
• Jakarta
• javax

This can be used with more than one controller on any or all the supported libraries, however, they need to have different collection names.

Installation

Maven

    <dependency>
        <groupId>io.chocotea</groupId>
        <artifactId>chocotea</artifactId>
        <version>1.0EE</version>
    </dependency>

gradle

Add this dependency to your project's build file:

compile("io.chocotea:chocotea:1.0")

Usage (Annotations)

• @SpringCollection
• @SpringRequest
• @JakartaCollection
• @JakartaRequest
• @JavaxCollection
• @JavaxRequest
• @ChocoRandom
• @ChocoExpect
• @ChocoDuplicateTest
• @ChocoCurrencyTest

This library runs on compile, after which your collection and environment json files are stored in your-project-folder/target/generated-sources/annotations

Sample collection HERE Sample environment HERE

Language

This is the list of languages that can be passed to the request. The default is json and options are:

    text,
    json,
    javascript,
    html,
    xml

Auth

This is the list of auth type that can be passed to the request. The default is noauth and options are:

    apikey,
    awsv4,
    basic,
    bearer,
    digest,
    edgegrid,
    hawk,
    noauth,
    oauth1,
    oauth2,
    ntlm