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: <base_url>/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

API Reference

For detailed information about the API endpoints, request/response formats, and parameters, please refer to the API Reference document.

API Usage

Detailed examples of how to use the API endpoints can be found in the API Usage 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.