# Hitchhiker

**Repository Path**: wunderfly/Hitchhiker

## Basic Information

- **Project Name**: Hitchhiker
- **Description**: a Restful Api integrated testing tool
- **Primary Language**: TypeScript
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 87
- **Created**: 2017-10-16
- **Last Updated**: 2024-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <img src='https://raw.githubusercontent.com/brookshi/Hitchhiker/master/client/public/hitchhiker-title-dark.png' height='20'/>

Hitchhiker Api is a Restful Api integrated testing tool that support Schedule, Response comparsion, Stress Test etc. You can deploy it in your local server. It make easier to manage Api with your team.

[中文 Read Me](README_cn.md)

Go to [http://www.hitchhiker-api.com](http://www.hitchhiker-api.com) for test，use `try without login`. (Demo doesn't support stress test)

[Change log](change_log.md)

## Feature
* Api collaboration development with team
* Api history
* Multiple environments and Runtime variables support, easy to handle api dependence
* Request parameterization, include ManytoMany and OnetoOne, now you can use a request to handle multple situation like various query string, body
* Schedule and run batch
* Make a comparison for Api response between two different environments (eg: stage vs product)
* Support Handling response before comparing
* Easy to deploy (support docker, windows, linux), keep data in your control, never lose data
* All changed will be auto saved in local cache even if refresh page
* Support importing Postman v1 collections
* Distributed stress test
* Api Document (in future)

## Stress Test

[Hitchhiker-Node](https://github.com/brookshi/Hitchhiker-Node)

## Display

<img src='https://raw.githubusercontent.com/brookshi/images/master/Hitchhiker/collection.png' width='800'/>
<img src='https://raw.githubusercontent.com/brookshi/images/master/Hitchhiker/header.gif' width='800'/>
<img src='https://raw.githubusercontent.com/brookshi/images/master/Hitchhiker/history.png' width='800'/>
<img src='https://raw.githubusercontent.com/brookshi/images/master/Hitchhiker/parameters.gif' width='800'/>
<img src='https://raw.githubusercontent.com/brookshi/images/master/Hitchhiker/schedule.png' width='800'/>
<img src='https://raw.githubusercontent.com/brookshi/images/master/Hitchhiker/stresstest.gif' width='800'/>

## Deploy

Recommend use docker，it's easy and quickly，refer to [deploy with docker](doc/howtoinstall-docker-en.md)

Or you can deploy base on source code without docker, it's easy too.

linux: [deploy to linux](doc/howtoinstall-linux-en.md)

windows: [deploy to win](doc/howtoinstall-win-en.md)

## How to use

refer to [How to use](doc/howtouse-en.md)

## Browser

Only test in Chrome(Recommend) and Firefox, Don't have any plan to support the others.

## Licence

GPL-2.0 + Commercial use prohibited