{"id":13844985,"url":"https://github.com/reconmap/rest-api","last_synced_at":"2025-04-09T12:06:01.059Z","repository":{"id":37589901,"uuid":"285874502","full_name":"reconmap/rest-api","owner":"reconmap","description":"REST API backend for Reconmap","archived":false,"fork":false,"pushed_at":"2024-10-28T19:25:32.000Z","size":14025,"stargazers_count":47,"open_issues_count":7,"forks_count":22,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-29T16:58:16.203Z","etag":null,"topics":["api","cve","hacktoberfest","ipe","nmap","pentesting","reconnaissance","secdevops","security","vulnerability"],"latest_commit_sha":null,"homepage":"https://reconmap.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reconmap.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-07T16:28:58.000Z","updated_at":"2024-10-28T19:24:36.000Z","dependencies_parsed_at":"2024-07-07T22:08:45.872Z","dependency_job_id":"7e8aad3c-e177-46e4-bab7-dfb6671ce144","html_url":"https://github.com/reconmap/rest-api","commit_stats":{"total_commits":680,"total_committers":14,"mean_commits":48.57142857142857,"dds":"0.044117647058823484","last_synced_commit":"93c82c0b1e955313ce3c51adbacaa45419326c5b"},"previous_names":["reconmap/api-backend"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reconmap%2Frest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reconmap%2Frest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reconmap%2Frest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reconmap%2Frest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reconmap","download_url":"https://codeload.github.com/reconmap/rest-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247342832,"owners_count":20923661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cve","hacktoberfest","ipe","nmap","pentesting","reconnaissance","secdevops","security","vulnerability"],"created_at":"2024-08-04T17:03:05.219Z","updated_at":"2025-04-09T12:06:01.032Z","avatar_url":"https://github.com/reconmap.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"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)\n[![Maintainability](https://api.codeclimate.com/v1/badges/7bebfcc41dce2610de78/maintainability)](https://codeclimate.com/github/reconmap/rest-api/maintainability)\n[![codecov](https://codecov.io/gh/reconmap/rest-api/branch/master/graph/badge.svg?token=VTC6RAM41Q)](https://codecov.io/gh/reconmap/rest-api)\n[![Gitter](https://badges.gitter.im/reconmap/community.svg)](https://gitter.im/reconmap/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\n# Reconmap Rest API\n\nThe Reconmap API is a RESTful API that allows any of the clients (Web, CLI, Mobile) to manipulate any of the Reconmap's\nentities: projects, tasks, commands, reports, users, etc. With the API you can extend Reconmap in any way you can\nimagine.\n\nThis is a component of many in the [Reconmap's architecture](https://reconmap.org/development/architecture.html).\n\n## Runtime requirements\n\n- Docker\n- Docker compose\n- Make\n\n## Documentation\n\nThe API specs have been documented using the [OpenAPI](docs/openapi.yaml) specification. You can use the\ninteractive [OpenAPI UI](https://api.reconmap.org/docs/) to play with it.\n\n## Build instructions\n\nThe first thing you need to do is build the containers and prepare the app. This can be achieved by invoking the default\nmake target:\n\n```sh\nmake\n```\n\nOnce the containers are built, and the app prepared, you can run the docker services with the following command:\n\n```sh\nmake start\n```\n\nIf everything went ok you should be able to use curl or any other HTTP client (eg your browser) to call the API:\n\n```sh\ncurl http://localhost:5510\n```\n\n## How to contribute\n\n**We are glad you are thinking about contributing to this project.** All help is hugely appreciated.\n\nBefore you jump to make any changes make sure you have read\nthe [contributing guidelines](https://github.com/reconmap/.github/blob/main/CONTRIBUTING.md). This would\nsave us all time. Thanks!\n\n## How to report bugs or feature requests\n\nIf you have bugs or feature requests to report please use the [issues](https://github.com/reconmap/application/issues)\ntab on Github.\n\nIf you want to chat to somebody on the development team head to our [Gitter](https://gitter.im/reconmap/community)\ncommunity.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freconmap%2Frest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freconmap%2Frest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freconmap%2Frest-api/lists"}