# crAPI | Completely Ridiculous API

**URL:** <https://onehack.st/t/crapi-completely-ridiculous-api/222809>\
**Category:** Tools & Scripts\
**Tags:** learning, tools, hosting\
**Created:** [August 21, 2022, 6:56pm UTC](https://onehack.st/t/crapi-completely-ridiculous-api/222809 "2022-08-21T18:56:50Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![NoBody](https://onehack.st/user_avatar/onehack.st/nobody/32/163880_2.png) [@NoBody](https://onehack.st/u/NoBody)\
**Post date:** [August 21, 2022, 6:56pm UTC](https://onehack.st/t/crapi-completely-ridiculous-api/222809/1 "2022-08-21T18:56:50Z")

</div>

![image](https://onehack.st/uploads/default/original/3X/d/7/d72ca51ce06d558748ce5c5d11ae92e9a78abb0d.jpeg)

# crAPI

**c** ompletely **r** idiculous **API** (crAPI) will help you to understand the ten most critical API security risks. crAPI is vulnerable by design, but you’ll be able to safely run it to educate/train yourself.

crAPI is modern, built on top of a microservices architecture. When time has come to buy your first car, sign up for an account and start your journey. To know more about crAPI, please check [crAPI’s overview](https://github.com/OWASP/crAPI/blob/develop/docs/overview.md).

## QuickStart Guide

### Docker

You’ll need to have Docker installed and running on your host system.

#### Using prebuilt images

You can use prebuilt images generated by our CI workflow.

- To use the latest stable version.
  - Linux Machine

```auto
curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml

docker-compose pull

docker-compose -f docker-compose.yml --compatibility up -d

```

- Windows Machine

```auto
curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml

docker-compose pull

docker-compose -f docker-compose.yml --compatibility up -d

```

- To use the latest development version
  - Linux Machine

```auto
curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml

VERSION=develop docker-compose pull 

VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d

```

- Windows Machine

```auto
curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml

set "VERSION=develop"

docker-compose pull

docker-compose -f docker-compose.yml --compatibility up -d

```

Visit [http://localhost:8888](http://localhost:8888/)

**Note** : All emails are sent to mailhog service by default and can be checked on [http://localhost:8025](http://localhost:8025/) You can change the smtp configuration if required however all emails with domain **[example.com](http://example.com)** will still go to mailhog.

### Vagrant

This option allows you to run crAPI within a virtual machine, thus isolated from your system. You’ll need to have [Vagrant](https://www.vagrantup.com/downloads) and, for example [VirtualBox](https://www.virtualbox.org/wiki/Downloads) installed.

1. Clone crAPI repository

```auto
$ git clone [REPOSITORY-URL]

```

1. Start crAPI Virtual Machine

```auto
$ cd deploy/vagrant && vagrant up

```

1. Visit [http://192.168.33.20](http://192.168.33.20/)

**Note** : All emails are sent to mailhog service and can be checked on [http://192.168.33.20:8025](http://192.168.33.20:8025/)

Once you’re done playing with crAPI, you can remove it completely from your system running the following command from the repository root directory

```auto
$ cd deploy/vagrant && vagrant destroy

```

## For more deployment options visit [the setup instructions](https://github.com/OWASP/crAPI/blob/develop/docs/setup.md) for more details.

## To know more about challenges in crAPI. Visit [challenges](https://github.com/OWASP/crAPI/blob/develop/docs/challenges.md)

## GitHub:

> **[GitHub - OWASP/crAPI: completely ridiculous API (crAPI)](https://github.com/OWASP/crAPI)**
>
> completely ridiculous API (crAPI)