https://github.com/scyth3-c/knock-cpp-api

API to compile C++ where the sun shines ☀️ - cloud based
https://github.com/scyth3-c/knock-cpp-api

cloud cloud-based docker dockerfile javascript makefile nodejs typescript

Last synced: about 1 month ago
JSON representation

API to compile C++ where the sun shines ☀️ - cloud based

• Host: GitHub
• URL: https://github.com/scyth3-c/knock-cpp-api
• Owner: scyth3-c
• License: mit
• Created: 2022-04-12T20:40:43.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-31T16:44:53.000Z (about 1 year ago)
• Last Synced: 2024-10-05T06:48:50.454Z (about 2 months ago)
• Topics: cloud, cloud-based, docker, dockerfile, javascript, makefile, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 187 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        

# Knock Cpp API

Compile C++ everywhere with notes and code spaces!

## Getting Started

These instructions will guide you on how to use the API and make requests to its endpoints.

### Prerequisites

To interact with the API, you will need:

- A tool to make HTTP requests (e.g., cURL, Postman)

### API Base URL

The base URL for accessing the API is: `/api/v2`

## API Endpoints

The API exposes the following endpoints:

### Addon

- `POST /addon/compile`: Compiles source code.

- `POST /addon/download`: Downloads source code.

- `POST /addon/assembly`: Generates assembly code.

### Notes

- `POST /notes/new`: Creates a new note.

- `PUT /notes/update`: Update a note.

- `GET /notes/find`: Retrieves the notes.

- `POST /notes/items`: Adds items to the notes.

- `DELETE /notes/delete`: Deletes a note by ID.

- `GET /notes/show`: Retrieves a note by ID.

- `GET /notes/last`: Retrieves the last note.

### Crypto

- `GET /crypto/sha256`: Generates SHA256 hash.

## Codespaces

- `POST /codespaces/new`: Creates a new codespaces.

- `POST /codespaces/findone`: Creates a new codespaces.

- `GET /codespaces/find`: Retrieves the codespaces.

- `PUT /codespaces/update`: Update a codespaces by ID.

- `DELETE /codespaces/delete`: Deletes a codespaces by ID.

## Sys

- `GET /sys/exceptions/`: Retrieves the system exceptions

- `GET /sys/exceptions/last`: Retrieves the last system exception

## API Swagger DOC

for detailed information about the API endpoints

[API Doc](https://github.com/scyth3-c/knock-cpp-API/blob/master/Doc/Knock-Cpp-API-DOC.yaml)

## API Reference

For detailed information about the API endpoints, request/response formats, and parameters, please refer to the [API Reference](https://github.com/scyth3-c/knock-cpp-API/blob/master/Doc/api-reference.md) document.

## API Usage

Detailed examples of how to use the API endpoints can be found in the [API Usage](https://github.com/scyth3-c/knock-cpp-API/blob/master/Doc/api-usage.md) document.

## Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please create an issue or submit a pull request.

## License

This project is licensed under the [MIT License](LICENSE).