- Introduction
- Project Structure
- Setup Instructions
- Usage
- Endpoints
- Files and Directories
- Contributing
- License
Provide a brief overview of your project, including its purpose and key features. Mention that this project utilizes FastAPI, Docker, and related technologies.
Briefly describe the structure of your project. Highlight key files and directories relevant to the project setup and functionality.
List prerequisites such as Docker, Python, and any specific versions required to run the project.
-
Clone the repository:
git clone https://github.com/tsuriu/custom_api.git cd custom_api
-
Build and run the Docker containers:
docker-compose up --build
This command builds the Docker image using the Dockerfile and starts the containers defined in
docker-compose.yml
.
Describe how to use the project once it's set up. Include any specific commands or steps needed to interact with the application or API.
This endpoint scans a specified host and port using Nmap.
- Method: GET
- URL:
/api/nmap_custom/
- Parameters:
host
(required): Hostname or IP address to scan.port
(required): Port number to scan.
curl -X 'GET' \
'http://localhost:8000/api/nmap_custom?host=example.com&port=80'
This endpoint fetches HTTP request header details from a specified URL.
- Method: GET
- URL:
/api/http_custom/
- Parameters:
url
(required): URL to fetch details from.mode
(optional): Mode of fetching details (http
,cert
,both
). Defaults toboth
.
curl -X 'GET' \
'http://localhost:8000/api/http_custom?url=example.com&mode=both'
Contains instructions to build the Docker image for the project.
Contains the main application code and related files.
Defines services, networks, and volumes for multi-container Docker applications.
Lists Python dependencies required by the application.
Explain how others can contribute to your project. Include guidelines for pull requests and reporting issues.
Specify the project's license (e.g., MIT, Apache 2.0).