https://github.com/reconmap/rest-api

REST API backend for Reconmap
https://github.com/reconmap/rest-api

api cve hacktoberfest ipe nmap pentesting reconnaissance secdevops security vulnerability

Last synced: about 1 month ago
JSON representation

REST API backend for Reconmap

• Host: GitHub
• URL: https://github.com/reconmap/rest-api
• Owner: reconmap
• License: apache-2.0
• Created: 2020-08-07T16:28:58.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T06:41:35.000Z (about 2 months ago)
• Last Synced: 2024-08-01T03:10:38.845Z (about 2 months ago)
• Topics: api, cve, hacktoberfest, ipe, nmap, pentesting, reconnaissance, secdevops, security, vulnerability
• Language: PHP
• Homepage: https://reconmap.com
• Size: 13.6 MB
• Stars: 47
• Watchers: 6
• Forks: 22
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - reconmap/rest-api - REST API backend for Reconmap (PHP)

README

        
[![Build and deployment workflow](https://github.com/reconmap/rest-api/actions/workflows/build-deployment.yml/badge.svg)](https://github.com/reconmap/rest-api/actions/workflows/build-deployment.yml)

[![Maintainability](https://api.codeclimate.com/v1/badges/7bebfcc41dce2610de78/maintainability)](https://codeclimate.com/github/reconmap/rest-api/maintainability)

[![codecov](https://codecov.io/gh/reconmap/rest-api/branch/master/graph/badge.svg?token=VTC6RAM41Q)](https://codecov.io/gh/reconmap/rest-api)

[![Gitter](https://badges.gitter.im/reconmap/community.svg)](https://gitter.im/reconmap/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# Reconmap Rest API

The Reconmap API is a RESTful API that allows any of the clients (Web, CLI, Mobile) to manipulate any of the Reconmap's

entities: projects, tasks, commands, reports, users, etc. With the API you can extend Reconmap in any way you can

imagine.

This is a component of many in the [Reconmap's architecture](https://reconmap.org/development/architecture.html).

## Runtime requirements

- Docker

- Docker compose

- Make

## Documentation

The API specs have been documented using the [OpenAPI](docs/openapi.yaml) specification. You can use the

interactive [OpenAPI UI](https://api.reconmap.org/docs/) to play with it.

## Build instructions

The first thing you need to do is build the containers and prepare the app. This can be achieved by invoking the default

make target:

```sh

make

```

Once the containers are built, and the app prepared, you can run the docker services with the following command:

```sh

make start

```

If everything went ok you should be able to use curl or any other HTTP client (eg your browser) to call the API:

```sh

curl http://localhost:5510

```

## How to contribute

**We are glad you are thinking about contributing to this project.** All help is hugely appreciated.

Before you jump to make any changes make sure you have read the [contributing guidelines](CONTRIBUTING.md). This would

save us all time. Thanks!

## How to report bugs or feature requests

If you have bugs or feature requests to report please use the [issues](https://github.com/reconmap/application/issues)

tab on Github.

If you want to chat to somebody on the development team head to our [Gitter](https://gitter.im/reconmap/community)

community.