Skip to content

Commit 436fda7

Browse files
committed
Enhance README.md with detailed API documentation and usage instructions
1 parent e910596 commit 436fda7

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
11
# API-Doc
22
API Documentation for APTRS
3+
4+
## About This API Collection
5+
This repository contains the complete API documentation for APTRS (Automated Penetration Testing Reporting System) in Bruno format. The collection provides endpoints for all APTRS functionality organized by domain areas.
6+
7+
## Using the Bruno Collection
8+
To use this API collection:
9+
10+
1. Download and install [Bruno](https://www.usebruno.com/) - an open-source API client
11+
2. Clone this repository: `git clone <repository-url>`
12+
3. Open Bruno and use "Open Collection" to navigate to the cloned `APTRS` folder
13+
4. Select the `APTRS.bru` environment file in the environments folder to configure your base URL and authentication
14+
15+
## Collection Structure
16+
The API collection is organized into the following main sections:
17+
18+
- **Account** - Authentication, user management, and profile operations
19+
- **Company** - Company management and customer portal APIs
20+
- **Customer** - Customer management operations
21+
- **Project** - Project management, reports, scope, and vulnerability operations
22+
- **Config APIs** - System configuration and status endpoints
23+
- **Vulnerability Database** - Template and vulnerability data management
24+
25+
## Contributing
26+
To contribute to this API documentation:
27+
1. Make your changes in Bruno
28+
2. Export the collection (if needed)
29+
3. Submit a pull request with your changes
30+
31+
## Support
32+
For questions about the API documentation or issues with the collection, please open an issue in this repository.

0 commit comments

Comments
 (0)